Package com.sas.metadata.remote

Interface ArchiveEntry

All Superinterfaces:
CMetadata, ContentLocation, DeployedDataPackage, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root, Text
public interface ArchiveEntry extends Text
One of several metadata types used to describe the physical location of some form of content. ArchiveEntry describes a unit of content in an archive file.

Attributes of ArchiveEntry are:

Associations of ArchiveEntry are:

Usage

To create an instance of this ArchiveEntry, use the factory create methods.
Example: create a ArchiveEntry with name "ArchiveEntry_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();
 ArchiveEntry myObject = (ArchiveEntry) factory.createComplexMetadataObject(objectStore, "ArchiveEntry_Object", MetadataObjects.ARCHIVEENTRY, "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_ENTRYNAME_NAME

      static final String ATTRIBUTE_ENTRYNAME_NAME
      Constant used for the name of the EntryName attribute.

      EntryName: The name of the entry in the archive file.

      See Also:

    • ATTRIBUTE_PATH_NAME

      static final String ATTRIBUTE_PATH_NAME
      Constant used for the name of the Path attribute.

      Path: This is the path name stored in the archive file for this entry.

      See Also:

    • ASSOCIATION_OWNINGARCHIVE_NAME

      static final String ASSOCIATION_OWNINGARCHIVE_NAME
      Constant used for the name of the OwningArchive association.

      OwningArchive: The archive file that contains this entry  

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getEntryName

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

    • getEntryNameState

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

    • getEntryNameMaxLength

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

    • getPath

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

    • getPathState

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

    • getPathMaxLength

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

    • getOwningArchives

      AssociationList getOwningArchives() throws RemoteException, MdException
      Gets the AssociationList of OwningArchives
      Returns:
      Returns the AssociationList of OwningArchives which can be of type:
      ArchiveFile
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException

    • getOwningArchive

      ArchiveFile getOwningArchive() throws RemoteException, MdException
      Gets the ArchiveFile for OwningArchive
      Returns:
      The ArchiveFile ( null if not set) of OwningArchivewhich can be of type:
      ArchiveFile
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getOwningArchives

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

    • setEntryName

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

    • setEntryName

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

    • setEntryNameState

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

    • setPath

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

    • setPath

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

    • setPathState

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

    • setOwningArchives

      void setOwningArchives(AssociationList list) throws RemoteException
      Sets the OwningArchives list to be list. Object of which can be of type:
      ArchiveFile
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningArchives

      void setOwningArchives(AssociationList list, int state) throws RemoteException
      Sets the OwningArchives list to be list. Object of which can be of type:
      ArchiveFile
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningArchive

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