Package com.sas.metadata.remote

Interface ArchiveFile

All Superinterfaces:
CMetadata, ContentLocation, DeployedDataPackage, File, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root, Text
public interface ArchiveFile extends File
Represents an archive, such as a tar file or a zip file, which may contain entries. It is one of several metadata types used to describe the physical location of some form of content.

Attributes of ArchiveFile are:

Associations of ArchiveFile are:

Usage

To create an instance of this ArchiveFile, use the factory create methods.
Example: create a ArchiveFile with name "ArchiveFile_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();
 ArchiveFile myObject = (ArchiveFile) factory.createComplexMetadataObject(objectStore, "ArchiveFile_Object", MetadataObjects.ARCHIVEFILE, "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

    • ASSOCIATION_ARCHIVEENTRIES_NAME

      static final String ASSOCIATION_ARCHIVEENTRIES_NAME
      Constant used for the name of the ArchiveEntries association.

      ArchiveEntries: The entries in this archive file. 

      See Also:

    • ASSOCIATION_ASSOCIATEDMININGRESULT_NAME

      static final String ASSOCIATION_ASSOCIATEDMININGRESULT_NAME
      Constant used for the name of the AssociatedMiningResult association.

      AssociatedMiningResult: The Mining Result associated with this report. 

      See Also:

    • ASSOCIATION_OWNINGCHANNEL_NAME

      static final String ASSOCIATION_OWNINGCHANNEL_NAME
      Constant used for the name of the OwningChannel association.

      OwningChannel: The channel that published this archive. 

      See Also:

  • Method Details

    • initializeRequiredObjects

      void initializeRequiredObjects() throws RemoteException
      (S) This initializes the Required Objects(Roles) which are:
      Specified by:
      initializeRequiredObjects in interface ContentLocation
      Specified by:
      initializeRequiredObjects in interface DeployedDataPackage
      Specified by:
      initializeRequiredObjects in interface File
      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:
      Specified by:
      initializePredObjects in interface ContentLocation
      Specified by:
      initializePredObjects in interface DeployedDataPackage
      Specified by:
      initializePredObjects in interface File
      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.

    • getArchiveEntries

      AssociationList getArchiveEntries() throws RemoteException, MdException
      Gets the Association list of ArchiveEntries
      Returns:
      The AssociationList of ArchiveEntries which can be of type:
      ArchiveEntry
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getAssociatedMiningResults

      AssociationList getAssociatedMiningResults() throws RemoteException, MdException
      Gets the Association list of AssociatedMiningResults
      Returns:
      The AssociationList of AssociatedMiningResults which can be of type:
      MiningResult
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getAssociatedMiningResult

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

    • getOwningChannels

      AssociationList getOwningChannels() throws RemoteException, MdException
      Gets the Association list of OwningChannels
      Returns:
      The AssociationList of OwningChannels which can be of type:
      ITChannel
      Throws:
      RemoteException - If error connecting/communicating to/with remote object.
      MdException - If error getting/setting part of the object.

    • getOwningChannel

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

    • getArchiveEntries

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

    • getAssociatedMiningResults

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

    • getOwningChannels

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

    • setArchiveEntries

      void setArchiveEntries(AssociationList list) throws RemoteException
      Sets the ArchiveEntries list to be list. Objects of which can be of type:
      ArchiveEntry
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setArchiveEntries

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

    • setAssociatedMiningResults

      void setAssociatedMiningResults(AssociationList list) throws RemoteException
      Sets the AssociatedMiningResults list to be list. Objects of which can be of type:
      MiningResult
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedMiningResults

      void setAssociatedMiningResults(AssociationList list, int state) throws RemoteException
      Sets the AssociatedMiningResults list to be list. Objects of which can be of type:
      MiningResult
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setAssociatedMiningResult

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

    • setOwningChannels

      void setOwningChannels(AssociationList list) throws RemoteException
      Sets the OwningChannels list to be list. Objects of which can be of type:
      ITChannel
      Parameters:
      list - AssociationList
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningChannels

      void setOwningChannels(AssociationList list, int state) throws RemoteException
      Sets the OwningChannels list to be list. Objects of which can be of type:
      ITChannel
      Parameters:
      list - AssociationList
      state - int
      Throws:
      RemoteException - If error communicating with remote object.

    • setOwningChannel

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