com.silverpeas.admin.components
Class WAComponent

java.lang.Object
  extended by com.silverpeas.admin.components.WAComponent

public class WAComponent
extends Object

Java class for WAComponentType complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="WAComponentType">
   <complexContent>
     <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
       <sequence>
         <element name="name" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="label" type="{http://silverpeas.org/xml/ns/component}multilang"/>
         <element name="description" type="{http://silverpeas.org/xml/ns/component}multilang"/>
         <element name="suite" type="{http://silverpeas.org/xml/ns/component}multilang"/>
         <element name="visible" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="visibleInPersonalSpace" type="{http://www.w3.org/2001/XMLSchema}boolean" minOccurs="0"/>
         <element name="portlet" type="{http://www.w3.org/2001/XMLSchema}boolean"/>
         <element name="router" type="{http://www.w3.org/2001/XMLSchema}string" minOccurs="0"/>
         <element name="instanceClassName" type="{http://www.w3.org/2001/XMLSchema}string"/>
         <element name="profiles">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="profile" type="{http://silverpeas.org/xml/ns/component}ProfileType" maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
         <element name="parameters" minOccurs="0">
           <complexType>
             <complexContent>
               <restriction base="{http://www.w3.org/2001/XMLSchema}anyType">
                 <sequence>
                   <element name="parameter" type="{http://silverpeas.org/xml/ns/component}ParameterType" maxOccurs="unbounded" minOccurs="0"/>
                 </sequence>
               </restriction>
             </complexContent>
           </complexType>
         </element>
       </sequence>
     </restriction>
   </complexContent>
 </complexType>
 


Field Summary
protected  HashMap<String,String> description
           
protected  List<GroupOfParameters> groupsOfParameters
           
protected  Map<String,Parameter> indexedParametersByName
           
protected  String instanceClassName
           
protected  HashMap<String,String> label
           
protected  String name
           
protected  List<Parameter> parameters
           
protected  boolean portlet
           
protected  List<Profile> profiles
           
protected  String router
           
protected  HashMap<String,String> suite
           
protected  boolean visible
           
protected  boolean visibleInPersonalSpace
           
 
Constructor Summary
WAComponent()
           
 
Method Summary
 ParameterList getAllParameters()
           
 HashMap<String,String> getDescription()
          Gets the value of the description property.
 String getDescription(String lang)
           
 List<GroupOfParameters> getGroupsOfParameters()
           
 String getInstanceClassName()
          Gets the value of the instanceClassName property.
 HashMap<String,String> getLabel()
          Gets the value of the label property.
 String getLabel(String lang)
           
 String getName()
          Gets the value of the name property.
 List<Parameter> getParameters()
          Gets the value of the parameters property.
 Profile getProfile(String name)
           
 List<Profile> getProfiles()
          Gets the value of the profiles property.
 String getRouter()
          Gets the value of the router property.
 List<GroupOfParameters> getSortedGroupsOfParameters()
           
 List<Parameter> getSortedParameters()
           
 HashMap<String,String> getSuite()
          Gets the value of the suite property.
 String getSuite(String lang)
           
 boolean hasParameterDefined(String parameterName)
          Indicates if a parameter is defined which name is equal to the given method parameter.
 boolean isPortlet()
          Gets the value of the portlet property.
 boolean isVisible()
          Gets the value of the visible property.
 boolean isVisibleInPersonalSpace()
          Gets the value of the visibleInPersonalSpace property.
 void setDescription(HashMap<String,String> value)
          Sets the value of the description property.
 void setInstanceClassName(String value)
          Sets the value of the instanceClassName property.
 void setLabel(HashMap<String,String> value)
          Sets the value of the label property.
 void setName(String value)
          Sets the value of the name property.
 void setParameters(List<Parameter> parameters)
          Sets the value of the parameters property.
 void setPortlet(boolean value)
          Sets the value of the portlet property.
 void setProfiles(List<Profile> profiles)
          Sets the value of the profiles property.
 void setRouter(String value)
          Sets the value of the router property.
 void setSuite(HashMap<String,String> value)
          Sets the value of the suite property.
 void setVisible(boolean value)
          Sets the value of the visible property.
 void setVisibleInPersonalSpace(boolean value)
          Sets the value of the visibleInPersonalSpace property.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

name

protected String name

label

protected HashMap<String,String> label

description

protected HashMap<String,String> description

suite

protected HashMap<String,String> suite

visible

protected boolean visible

visibleInPersonalSpace

protected boolean visibleInPersonalSpace

portlet

protected boolean portlet

router

protected String router

instanceClassName

protected String instanceClassName

profiles

protected List<Profile> profiles

groupsOfParameters

protected List<GroupOfParameters> groupsOfParameters

parameters

protected List<Parameter> parameters

indexedParametersByName

protected Map<String,Parameter> indexedParametersByName
Constructor Detail

WAComponent

public WAComponent()
Method Detail

getName

public String getName()
Gets the value of the name property.

Returns:
possible object is String

setName

public void setName(String value)
Sets the value of the name property.

Parameters:
value - allowed object is String

getLabel

public HashMap<String,String> getLabel()
Gets the value of the label property.

Returns:
possible object is Multilang

getLabel

public String getLabel(String lang)

setLabel

public void setLabel(HashMap<String,String> value)
Sets the value of the label property.

Parameters:
value - allowed object is Multilang

getDescription

public HashMap<String,String> getDescription()
Gets the value of the description property.

Returns:
possible object is Multilang

getDescription

public String getDescription(String lang)

setDescription

public void setDescription(HashMap<String,String> value)
Sets the value of the description property.

Parameters:
value - allowed object is Multilang

getSuite

public HashMap<String,String> getSuite()
Gets the value of the suite property.

Returns:
possible object is Multilang

getSuite

public String getSuite(String lang)

setSuite

public void setSuite(HashMap<String,String> value)
Sets the value of the suite property.

Parameters:
value - allowed object is Multilang

isVisible

public boolean isVisible()
Gets the value of the visible property.


setVisible

public void setVisible(boolean value)
Sets the value of the visible property.


isVisibleInPersonalSpace

public boolean isVisibleInPersonalSpace()
Gets the value of the visibleInPersonalSpace property.

Returns:
possible object is Boolean

setVisibleInPersonalSpace

public void setVisibleInPersonalSpace(boolean value)
Sets the value of the visibleInPersonalSpace property.

Parameters:
value - allowed object is Boolean

isPortlet

public boolean isPortlet()
Gets the value of the portlet property.


setPortlet

public void setPortlet(boolean value)
Sets the value of the portlet property.


getRouter

public String getRouter()
Gets the value of the router property.

Returns:
possible object is String

setRouter

public void setRouter(String value)
Sets the value of the router property.

Parameters:
value - allowed object is String

getInstanceClassName

public String getInstanceClassName()
Gets the value of the instanceClassName property.

Returns:
possible object is String

setInstanceClassName

public void setInstanceClassName(String value)
Sets the value of the instanceClassName property.

Parameters:
value - allowed object is String

getProfiles

public List<Profile> getProfiles()
Gets the value of the profiles property.

Returns:
list of Profile

getProfile

public Profile getProfile(String name)

setProfiles

public void setProfiles(List<Profile> profiles)
Sets the value of the profiles property.

Parameters:
profiles - list of Profile

getParameters

public List<Parameter> getParameters()
Gets the value of the parameters property.

Returns:
list of Parameter

setParameters

public void setParameters(List<Parameter> parameters)
Sets the value of the parameters property.

Parameters:
parameters - list of Parameter

hasParameterDefined

public boolean hasParameterDefined(String parameterName)
Indicates if a parameter is defined which name is equal to the given method parameter.

Parameters:
parameterName - the parameter name to perform.
Returns:
true if a parameter is defined behind the specified method parameter, false otherwise.

getSortedParameters

public List<Parameter> getSortedParameters()

getAllParameters

public ParameterList getAllParameters()

getGroupsOfParameters

public List<GroupOfParameters> getGroupsOfParameters()

getSortedGroupsOfParameters

public List<GroupOfParameters> getSortedGroupsOfParameters()


Copyright © 2016 Silverpeas. All Rights Reserved.