Class RoleModel

java.lang.Object
com.highdeal.hci.HCIModelAdapter
com.highdeal.admin.hci.RoleModel
All Implemented Interfaces:
ITagNameProvider, IXMLMarshallable, XMLMapping, XMLMarshallable

public class RoleModel extends HCIModelAdapter implements XMLMapping
This Java class represents a role that can be assigned to the SAP CC users; It contains a set of authorizations to allow or not the execution of certain operations by the connected SAP CC system. Predefined roles are configured in the SAP CC system.

Roles are customized levels of combined authorizations that grant the SAP CC users with specific access and control rights within the system. An SAP CC user can have several roles.
Each operation API requires an authorization that must belong to the SAP CC user specified as message originator of the corresponding operation request.

Caution

Consult the SAP CC Security Guide about the role and authorization concept of SAP Convergent Charging.

Additional Information

Consult the product documentation of SAP Convergent Charging:

  • See the SAP CC Security Guide about the default roles provided in the software
  • See the SAP CC Authorization Reference about the complete reference of existing authorizations

See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="role">
  <xs:complexType>
   <xs:sequence>
    <xs:element name="description" type="DescriptionType" minOccurs="0" maxOccurs="1" />
    <xs:element name="authorizationId" minOccurs="0" maxOccurs="unbounded">
      <xs:complexType>
        <xs:attribute name="value" type="xs:string"/>
      </xs:complexType>
    </xs:element>
   </xs:sequence>
   <xs:attribute name="id" type="xs:string" use="required"/>
  </xs:complexType>
 </xs:element>

  • Field Details

    • TAG_NAME

      public static final String TAG_NAME
      The value of that constant is the XML tag name of the role: role.
      See Also:
  • Constructor Details

    • RoleModel

      public RoleModel()
      Initialize a role model.
  • Method Details

    • getId

      public String getId()
      Gets the unique identifier of the role
      Returns:
      The identifier of the role
    • setId

      public void setId(String id)
      Sets the ID of the role; this ID is unique in the system.
      Parameters:
      id - The identifier of the role
    • getDescription

      public String getDescription()
      Gets the description of the role
      Returns:
      The description of the role
    • setDescription

      public void setDescription(String description)
      Sets the description of the role
      Parameters:
      description - The description of the role
    • getAuthorizationIds

      public List<String> getAuthorizationIds()
      Gets the list of authorization identifiers of the role
      Returns:
      The list of authorization identifiers of the role
    • marshalAttributes

      public void marshalAttributes(XMLOutputter output)
      Description copied from interface: IXMLMarshallable
      Gives an XML representation of the attributes of an object.
      Specified by:
      marshalAttributes in interface IXMLMarshallable
      Parameters:
      output - The XML output to marshal the object attributes into
    • marshalChildren

      public void marshalChildren(XMLOutputter output)
      Description copied from interface: IXMLMarshallable
      Gives an XML representation of the child objects of an object.
      Specified by:
      marshalChildren in interface IXMLMarshallable
      Parameters:
      output - The XML output to marshal the child objects into
    • setAttributes

      public void setAttributes(XMLAttributes atts)
      Description copied from interface: XMLMarshallable
      Sets the attributes of the XML representation of the element being processed.
      Specified by:
      setAttributes in interface XMLMarshallable
      Parameters:
      atts - The XML attributes of the current element
    • addChild

      public void addChild(String tagName, XMLMarshallable child)
      Description copied from interface: XMLMarshallable
      Adds a child to the object, the child representing the marshallable object which must be added to the element.
      Specified by:
      addChild in interface XMLMarshallable
      Parameters:
      tagName - The name of tag for the child
      child - The child to be added
    • addCharacterData

      public void addCharacterData(String cData)
      Description copied from interface: XMLMarshallable
      Adds character data to the content element.
      Specified by:
      addCharacterData in interface XMLMarshallable
      Parameters:
      cData - The character data to be added
    • getTagName

      public String getTagName()
      Description copied from interface: ITagNameProvider
      Gets the XML tag name of the HCI model.
      Specified by:
      getTagName in interface ITagNameProvider
      Returns:
      The XML tag name
    • getClass

      public Class<?> getClass(String nsUri, String tag, XMLAttributes atts)
      Description copied from interface: XMLMapping
      Returns the Java class for a specified XML tag and its attributes in a namespace.
      Specified by:
      getClass in interface XMLMapping
      Parameters:
      nsUri - The unique resource identifier of the namespace of the XML tag
      tag - The local part of the XML tag
      atts - The attributes of the XML tag
      Returns:
      A Java class with a default constructor