Package com.sas.metadata.remote

Interface JFJob

All Superinterfaces:
AbstractJob, AbstractTransformation, CMetadata, MdObjectBase, MdObjectBaseUtil, MdObjectBaseXML, PrimaryType, Remote, Root, Transformation
public interface JFJob extends AbstractJob
Represents a job that has been or will be scheduled in the LSF JobFlow.

Attributes of JFJob are:

Associations of JFJob are:

Usage

To create an instance of this JFJob, use the factory create methods.
Example: create a JFJob with name "JFJob_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();
 JFJob myObject = (JFJob) factory.createComplexMetadataObject(objectStore, "JFJob_Object", MetadataObjects.JFJOB, "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_ASSOCIATEDJOB_NAME

      static final String ASSOCIATION_ASSOCIATEDJOB_NAME
      Constant used for the name of the AssociatedJob association.

      AssociatedJob: Job that the JobFlow job is associated with. 

      See Also:

  • Method Details

    • initializeRequiredObjects

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

    • getAssociatedJobs

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

    • getAssociatedJob

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

    • getAssociatedJobs

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

    • setAssociatedJobs

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

    • setAssociatedJobs

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

    • setAssociatedJob

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