Package com.sas.metadata.remote

Interface IdentityGroup

All Superinterfaces:
CMetadata, Identity, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root
public interface IdentityGroup extends Identity
Grouping mechanism for identity objects. A IdentityGroup may also be a member of another IdentityGroup

Attributes of IdentityGroup are:

Associations of IdentityGroup are:

Usage

To create an instance of this IdentityGroup, use the factory create methods.
Example: create a IdentityGroup with name "IdentityGroup_Object", in repository "AAAAAAAA".
 // create a store to contain your objects for this change. If you do not have an existing object
 // or store to use.  You may obtain the store from another object by using Object.getObjectStore().
 MdFactory factory; //where "factory" is a valid MdFactory instance
 MdObjectStore objectStore = factory.createObjectStore();
 IdentityGroup myObject = (IdentityGroup) factory.createComplexMetadataObject(objectStore, "IdentityGroup_Object", MetadataObjects.IDENTITYGROUP, "AAAAAAAA");
 myObject.updateMetadataAll();  // Write object to server
 objectStore.dispose();  // dispose of the object store if it is no longer needed

Behavior

  • Attributes and associations for this object can be retrieved by using the methods in MdOMIUtil.
  • When changes are made to the object, either by setting an attribute or adding objects to a particular association, they can be persisted to the metadata server with the updateMetadataAll method.
  • If an object needs to be deleted, the delete method can be used. This will flag the object as being deleted on the client, and will require an update call to persist the change to the server.

Dependencies

This class depends on objects being contained in an MdObjectStore. Object stores should be disposed of when they are no longer needed as this will help clean up memory. Disposing an object store will dispose of all objects contained within that store.

Since:
9.0

  • Field Details

    • ATTRIBUTE_GROUPTYPE_NAME

      static final String ATTRIBUTE_GROUPTYPE_NAME
      Constant used for the name of the GroupType attribute.

      GroupType: GroupType

      See Also:

    • ASSOCIATION_MEMBERIDENTITIES_NAME

      static final String ASSOCIATION_MEMBERIDENTITIES_NAME
      Constant used for the name of the MemberIdentities association.

      MemberIdentities: The identities that are a part of this group.  

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface Identity
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface PrimaryType
      Specified by:
      initializeRequiredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • initializePredObjects

      void initializePredObjects() throws RemoteException
      (S) Adds the Associated objects to the predObjects which are:
      MemberIdentities
      Specified by:
      initializePredObjects in interface Identity
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface PrimaryType
      Specified by:
      initializePredObjects in interface Root
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getGroupType

      String getGroupType() throws RemoteException
      Gets the String value of GroupType
      Returns:
      The GroupType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getGroupTypeState

      int getGroupTypeState() throws RemoteException
      Gets the Metadata State of GroupType
      Returns:
      The State.
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getGroupTypeMaxLength

      int getGroupTypeMaxLength() throws RemoteException
      Gets the maximum length of GroupType
      Returns:
      The max size
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.

    • getMemberIdentities

      AssociationList getMemberIdentities() throws RemoteException, MdException
      Gets the AssociationList of MemberIdentities
      Returns:
      Returns the AssociationList of MemberIdentities which can be of type:
      Identity
      IdentityGroup
      Person
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getMemberIdentities

      AssociationList getMemberIdentities(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of MemberIdentities
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of MemberIdentities which can be of type:
      Identity
      IdentityGroup
      Person
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • setGroupType

      void setGroupType(String inGroupType) throws RemoteException
      Sets the GroupType value and sets the state to MetadataState.LOCAL.
      Parameters:
      inGroupType - String
      Throws:
      RemoteException - If error communicating with remote object.

    • setGroupType

      void setGroupType(String inGroupType, int state) throws RemoteException
      Sets the GroupType Metadata State.
      Parameters:
      inGroupType - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setGroupTypeState

      void setGroupTypeState(int state) throws RemoteException
      Sets the Metadata State of GroupType.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setMemberIdentities

      void setMemberIdentities(AssociationList list) throws RemoteException
      Sets the MemberIdentities list to be list. Objects of which can be of type:
      Identity
      IdentityGroup
      Person
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setMemberIdentities

      void setMemberIdentities(AssociationList inObjects, int state) throws RemoteException
      Sets the entire AssociationList to match the passed in Vector, sets the state of the AssociationList
      Parameters:
      inObjects - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.