Interface SecurityTypeContainmentRule

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

public interface SecurityTypeContainmentRule extends SecurityRule
A SecurityTypeContainmentRule tells the authorization facility how to find parent objects for a particular metadata type. There may be more than one rule for any class.

Attributes of SecurityTypeContainmentRule are:

Associations of SecurityTypeContainmentRule are:

Usage

To create an instance of this SecurityTypeContainmentRule, use the factory create methods.
Example: create a SecurityTypeContainmentRule with name "SecurityTypeContainmentRule_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();
 SecurityTypeContainmentRule myObject = (SecurityTypeContainmentRule) factory.createComplexMetadataObject(objectStore, "SecurityTypeContainmentRule_Object", MetadataObjects.SECURITYTYPECONTAINMENTRULE, "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_TYPENAME_NAME

      static final String ATTRIBUTE_TYPENAME_NAME
      Constant used for the name of the TypeName attribute.

      TypeName: Name of metadata type for which this rule applies.

      See Also:
  • Method Details

    • initializeRequiredObjects

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

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

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

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

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

      void setTypeName(String inTypeName, int state) throws RemoteException
      Sets the TypeName Metadata State.
      Parameters:
      inTypeName - String
      state - int
      Throws:
      RemoteException - If error communicating with remote object.
    • setTypeNameState

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