Package com.aquima.interactions.portal.ds.sys.metamodel

Class Roles

java.lang.Object
com.aquima.interactions.portal.ds.sys.metamodel.Roles
All Implemented Interfaces:
IReportingDS, IAttributeDS
public class Roles extends Object implements IAttributeDS
This class provides the data for the user.roles attribute.
Since:
9.1
Author:
T. Middeldorp

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    NAME
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    Roles()
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addMessage(ErrorCode code, String[] parameters, Severity severity)
    This method will add an initialization error to the report for the specified error code and parameters.
    DataType
    getDataType()
    This method returns the data type of the attribute.
    String
    getDescription()
    This method return the description for this attribute.
    String
    getDomainName()
    This method returns the name of the domain for the attribute.
    String
    getFunctionalName()
    This method return the functional name for this attribute.
    String
    getId()
    This method returns the unique identifier of the attribute, consisting of the entity in which the attribute is defined plus the attribute name, lowercased, e.g.
    String
    getName()
    This method returns the name of the attribute.
    IReferenceDS
    getReference()
    This method returns the reference of the attribute
    IRelationDS
    getRelation()
    This method returns an object containing information about the relation.
    boolean
    isAskable()
    This method returns a boolean indicating if the attribute value can be provided by the client.
    boolean
    isMultiValue()
    This method returns whether the profile contains (or may contain) multiple values for this attribute.
    boolean
    isReference()
    This method returns a boolean indicating that this attribute acts as a reference
    boolean
    isReverseAttribute()
    This method returns a boolean indicating this attribute is a reverse relation attribute.

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Field Details

  • Constructor Details

    • Roles

      public Roles()

  • Method Details

    • getDataType

      public DataType getDataType()
      Description copied from interface: IAttributeDS
      This method returns the data type of the attribute.
      Specified by:
      getDataType in interface IAttributeDS
      Returns:
      The data type of the attribute.

    • getDomainName

      public String getDomainName()
      Description copied from interface: IAttributeDS
      This method returns the name of the domain for the attribute. The domain name may be empty null when the attribute has no domain.
      Specified by:
      getDomainName in interface IAttributeDS
      Returns:
      The id of the domain the values are restricted to.

    • getId

      public String getId()
      Description copied from interface: IAttributeDS
      This method returns the unique identifier of the attribute, consisting of the entity in which the attribute is defined plus the attribute name, lowercased, e.g. entity.attribute
      Specified by:
      getId in interface IAttributeDS
      Returns:
      the unique identifier of the attribute.

    • getName

      public String getName()
      Description copied from interface: IAttributeDS
      This method returns the name of the attribute.
      Specified by:
      getName in interface IAttributeDS
      Returns:
      The name of the attribute.

    • getRelation

      public IRelationDS getRelation()
      Description copied from interface: IAttributeDS
      This method returns an object containing information about the relation. The relation information is only relevant for the data type Entity, and should return null for attributes of other data types.
      Specified by:
      getRelation in interface IAttributeDS
      Returns:
      data source containing information about the relation.

    • isAskable

      public boolean isAskable()
      Description copied from interface: IAttributeDS
      This method returns a boolean indicating if the attribute value can be provided by the client.
      Specified by:
      isAskable in interface IAttributeDS
      Returns:
      boolean indicating if the client is able to provide a value for this attribute.

    • isMultiValue

      public boolean isMultiValue()
      Description copied from interface: IAttributeDS
      This method returns whether the profile contains (or may contain) multiple values for this attribute. Attributes that can have multiple values in the profile should also define a multi-value strategy.
      Specified by:
      isMultiValue in interface IAttributeDS
      Returns:
      boolean indicating whether the profile can contain multiple values for this attribute.

    • getDescription

      public String getDescription()
      Description copied from interface: IAttributeDS
      This method return the description for this attribute.
      Specified by:
      getDescription in interface IAttributeDS
      Returns:
      Return the description for this attribute

    • isReverseAttribute

      public boolean isReverseAttribute()
      Description copied from interface: IAttributeDS
      This method returns a boolean indicating this attribute is a reverse relation attribute.
      Specified by:
      isReverseAttribute in interface IAttributeDS
      Returns:
      A boolean indicating this attribute is a reverse relation attribute.

    • addMessage

      public void addMessage(ErrorCode code, String[] parameters, Severity severity)
      Description copied from interface: IReportingDS
      This method will add an initialization error to the report for the specified error code and parameters.
      Specified by:
      addMessage in interface IReportingDS
      Parameters:
      code - Error code identifying the message.
      parameters - Optional array of parameters for the message.
      severity - The severity of the message.

    • getFunctionalName

      public String getFunctionalName()
      Description copied from interface: IAttributeDS
      This method return the functional name for this attribute.
      Specified by:
      getFunctionalName in interface IAttributeDS
      Returns:
      Return the functional name for this attribute

    • isReference

      public boolean isReference()
      Description copied from interface: IAttributeDS
      This method returns a boolean indicating that this attribute acts as a reference
      Specified by:
      isReference in interface IAttributeDS
      Returns:
      A boolean indicating that this attribute acts as a reference

    • getReference

      public IReferenceDS getReference()
      Description copied from interface: IAttributeDS
      This method returns the reference of the attribute
      Specified by:
      getReference in interface IAttributeDS
      Returns:
      The reference type of the attribute