Interface PermissionCondition

All Superinterfaces:
CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, Remote, Root, SecondaryType

public interface PermissionCondition extends SecondaryType
Stores an expression that is applied to conditionally grant a user or group access to a resource. The syntax of the expression is not explicitly defined as it varies depending on the resource to which it applies. PermissionCondition objects should not be explicitly created or deleted. PermissionCondition objects are created for you by the authorization tab as appropriate.

Attributes of PermissionCondition are:

Associations of PermissionCondition are:

Usage

To create an instance of this PermissionCondition, use the factory create methods.
Example: create a PermissionCondition with name "PermissionCondition_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();
 PermissionCondition myObject = (PermissionCondition) factory.createComplexMetadataObject(objectStore, "PermissionCondition_Object", MetadataObjects.PERMISSIONCONDITION, "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_TEXT_NAME

      static final String ATTRIBUTE_TEXT_NAME
      Constant used for the name of the Text attribute.

      Text: Condition expression.

      See Also:
    • ASSOCIATION_OWNINGACCESSCONTROLENTRY_NAME

      static final String ASSOCIATION_OWNINGACCESSCONTROLENTRY_NAME
      Constant used for the name of the OwningAccessControlEntry association.

      OwningAccessControlEntry: The access control entry that uses this condition.  

      See Also:
  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      OwningAccessControlEntry
      Specified by:
      initializeRequiredObjects in interface MdObjectBaseUtil
      Specified by:
      initializeRequiredObjects in interface Root
      Specified by:
      initializeRequiredObjects in interface SecondaryType
      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:
      OwningAccessControlEntry
      Specified by:
      initializePredObjects in interface MdObjectBase
      Specified by:
      initializePredObjects in interface Root
      Specified by:
      initializePredObjects in interface SecondaryType
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
    • getText

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

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

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

      AssociationList getOwningAccessControlEntrys() throws RemoteException, MdException
      Gets the AssociationList of OwningAccessControlEntrys
      Returns:
      Returns the AssociationList of OwningAccessControlEntrys which can be of type:
      AccessControlEntry
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException
    • getOwningAccessControlEntry

      AccessControlEntry getOwningAccessControlEntry() throws RemoteException, MdException
      Gets the AccessControlEntry for OwningAccessControlEntry
      Returns:
      The AccessControlEntry ( null if not set) of OwningAccessControlEntrywhich can be of type:
      AccessControlEntry
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.
    • getOwningAccessControlEntrys

      AssociationList getOwningAccessControlEntrys(boolean fGoToServer) throws RemoteException, MdException
      Gets the Associationlist of OwningAccessControlEntrys
      Parameters:
      fGoToServer - boolean Get the value from the server.
      Returns:
      Returns the AssociationList of OwningAccessControlEntrys which can be of type:
      AccessControlEntry
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.
    • setText

      void setText(String inText) throws RemoteException
      Sets the Text value and sets the state to MetadataState.LOCAL.
      Parameters:
      inText - String
      Throws:
      RemoteException - If error communicating with remote object.
    • setText

      void setText(String inText, int state) throws RemoteException
      Sets the Text Metadata State.
      Parameters:
      inText - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.
    • setTextState

      void setTextState(int state) throws RemoteException
      Sets the Metadata State of Text.
      Parameters:
      state - int
      Throws:
      RemoteException - If error communicating with remote object.
    • setOwningAccessControlEntrys

      void setOwningAccessControlEntrys(AssociationList list) throws RemoteException
      Sets the OwningAccessControlEntrys list to be list. Object of which can be of type:
      AccessControlEntry
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.
    • setOwningAccessControlEntrys

      void setOwningAccessControlEntrys(AssociationList list, int state) throws RemoteException
      Sets the OwningAccessControlEntrys list to be list. Object of which can be of type:
      AccessControlEntry
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.
    • setOwningAccessControlEntry

      void setOwningAccessControlEntry(AccessControlEntry inObject) throws RemoteException
      Sets the OwningAccessControlEntrys list 0th element to be inObject.
      Parameters:
      inObject - AccessControlEntry
      Throws:
      RemoteException - If error communicating with remote object.