org.jboss.shrinkwrap.descriptor.api.jbosscommon51
Interface SecurityRoleType<T>

All Superinterfaces:
org.jboss.shrinkwrap.descriptor.api.Child<T>
All Known Implementing Classes:
SecurityRoleTypeImpl

public interface SecurityRoleType<T>
extends org.jboss.shrinkwrap.descriptor.api.Child<T>

This interface defines the contract for the security-roleType xsd type

Original Documentation:

The security-role element contains the definition of a security role.
The definition consists of an the security role name and principal name element(s).

Since:
Generation date :2011-07-19T22:54:35.59+02:00
Author:
Ralf Battenfeld

Method Summary
 java.util.List<java.lang.String> getDescriptionList()
          Returns all description elements
 java.util.List<java.lang.String> getPrincipalNameList()
          Returns all principal-name elements
 java.lang.String getRoleName()
          Returns the role-name element
 SecurityRoleType<T> removeAllDescription()
          Removes the description element
 SecurityRoleType<T> removeAllPrincipalName()
          Removes the principal-name element
 SecurityRoleType<T> removeRoleName()
          Removes the role-name element
 SecurityRoleType<T> setDescription(java.lang.String description)
          Creates a new description element
 SecurityRoleType<T> setDescriptionList(java.lang.String... values)
          Creates for all String objects representing description elements, a new description element
 SecurityRoleType<T> setPrincipalName(java.lang.String principalName)
          Creates a new principal-name element
 SecurityRoleType<T> setPrincipalNameList(java.lang.String... values)
          Creates for all String objects representing principal-name elements, a new principal-name element
 SecurityRoleType<T> setRoleName(java.lang.String roleName)
          If not already created, a new role-name element with the given value will be created.
 
Methods inherited from interface org.jboss.shrinkwrap.descriptor.api.Child
up
 

Method Detail

setDescription

SecurityRoleType<T> setDescription(java.lang.String description)
Creates a new description element

Returns:
the current instance of SecurityRoleType

setDescriptionList

SecurityRoleType<T> setDescriptionList(java.lang.String... values)
Creates for all String objects representing description elements, a new description element

Parameters:
list - of description objects
Returns:
the current instance of SecurityRoleType

removeAllDescription

SecurityRoleType<T> removeAllDescription()
Removes the description element

Returns:
the current instance of SecurityRoleType

getDescriptionList

java.util.List<java.lang.String> getDescriptionList()
Returns all description elements

Returns:
list of description

setRoleName

SecurityRoleType<T> setRoleName(java.lang.String roleName)
If not already created, a new role-name element with the given value will be created. Otherwise, the existing role-name element will be updated with the given value.

Returns:
the current instance of SecurityRoleType

removeRoleName

SecurityRoleType<T> removeRoleName()
Removes the role-name element

Returns:
the current instance of SecurityRoleType

getRoleName

java.lang.String getRoleName()
Returns the role-name element

Returns:
the node defined for the element role-name

setPrincipalName

SecurityRoleType<T> setPrincipalName(java.lang.String principalName)
Creates a new principal-name element

Returns:
the current instance of SecurityRoleType

setPrincipalNameList

SecurityRoleType<T> setPrincipalNameList(java.lang.String... values)
Creates for all String objects representing principal-name elements, a new principal-name element

Parameters:
list - of principal-name objects
Returns:
the current instance of SecurityRoleType

removeAllPrincipalName

SecurityRoleType<T> removeAllPrincipalName()
Removes the principal-name element

Returns:
the current instance of SecurityRoleType

getPrincipalNameList

java.util.List<java.lang.String> getPrincipalNameList()
Returns all principal-name elements

Returns:
list of principal-name