Package com.highdeal.hci

Class ObjectAccessRuleModel

java.lang.Object
com.highdeal.hci.ObjectAccessRuleModel
All Implemented Interfaces:
XMLMarshallable
public class ObjectAccessRuleModel extends Object implements XMLMarshallable
This Java class represents an Object Access Rule. An Object Access Rule defines the rights to access to catalog objects.
See Also:

XML API for HCI

The XML APIs specify the following XSD fragment:

XSD Fragment

<xs:element name="objectAccessRule">
  <xs:complexType>
    <xs:sequence>
      <xs:element ref="additionalInformation" minOccurs="0" maxOccurs="1"/>
    </xs:sequence>
   <xs:attribute name="reference" type="xs:long"/>
   <xs:attribute name="isReadWriteLevel" type="xs:boolean" use="required"/>
  </xs:complexType>
 </xs:element>

  • Field Details

    • TAG_NAME

      public static final String TAG_NAME
      The XML tag name of this data model: "objectAccessRule"
      See Also:

  • Constructor Details

    • ObjectAccessRuleModel

      public ObjectAccessRuleModel()
      Constructs an empty Object Access Rule.

  • Method Details

    • getAddInfo

      public AdditionalInfoModel getAddInfo()
      Returns the Additional Info to filter the catalog objects, if any.
      Returns:
      the Additional Info if any

    • setAddInfo

      public void setAddInfo(AdditionalInfoModel addInfo)
      Sets the Additional Info to filter the catalog objects.
      Parameters:
      addInfo - the Additional Info to filter the catalog objects

    • setReference

      public void setReference(long ref)
      Sets the reference of the Object Access Rule.
      Parameters:
      ref - the reference of the Object Access Rule

    • getReference

      public long getReference()
      Gets the reference of the Object Access Rule.
      Returns:
      the reference of the Object Access Rule

    • setIsReadWriteLevel

      public void setIsReadWriteLevel(boolean isReadWriteLevel)
      Sets the flag that identify if the rule is for read/write access or only for read access.
      Parameters:
      isReadWriteLevel - the flag that identify if the rule is for read/write access or only for read access

    • isReadWriteLevel

      public boolean isReadWriteLevel()
      Gets the flag that identify if the rule is for read/write access or only for read access.
      Returns:
      true if the rule is for read/write access, false otherwise

    • 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

    • marshal

      public void marshal(XMLOutputter output)
      Description copied from interface: XMLMarshallable
      Gives an XML representation of this object, including its children.
      Specified by:
      marshal in interface XMLMarshallable
      Parameters:
      output - The XML output to marshal the object into