Package wt.viewmarkup

Class PublishCloudEntry

java.lang.Object
wt.fc._WTObject
wt.fc.WTObject
wt.fc._Item
wt.fc.Item
wt.viewmarkup._PublishCloudEntry
wt.viewmarkup.PublishCloudEntry
All Implemented Interfaces:
Externalizable, Serializable, wt.access._AccessControlled, wt.access._PolicyAccessControlled, wt.access._SecurityLabeled, AccessControlled, wt.access.PolicyAccessControlled, SecurityLabeled, wt.admin._DomainAdministered, DomainAdministered, wt.fc._NetFactor, wt.fc._ObjectMappable, wt.fc._Persistable, wt.fc.adminlock._AdministrativelyLockable, AdministrativelyLockable, NetFactor, ObjectMappable, Persistable, DisplayIdentification, wt.locks._Lockable, Lockable
@GenAsPersistable(superClass=Item.class,interfaces=Lockable.class,properties={@GeneratedProperty(name="startExec",type=java.sql.Timestamp.class,javaDoc="Time that execution started.",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="endExec",type=java.sql.Timestamp.class,javaDoc="Time execution finished (COMPLETED or FAILED).",accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="entryOwner",type=WTPrincipalReference.class,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="statusInfo",type=wt.viewmarkup.PublishEntryStatusInfo.class,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="cloudEntryNumber",type=java.lang.Long.class,accessors=@PropertyAccessors(setExceptions={}),constraints=@PropertyConstraints(required=true),columnProperties=@ColumnProperties(index=true,defaultValue="0")),@GeneratedProperty(name="failureCount",type=java.lang.Long.class,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="position",type=java.lang.Integer.class,accessors=@PropertyAccessors(setExceptions={})),@GeneratedProperty(name="args",type=java.io.Serializable.class,accessors=@PropertyAccessors(getAccess=PRIVATE),columnProperties=@ColumnProperties(columnType=INLINE_BLOB,oracleTableSize=HUGE)),@GeneratedProperty(name="vizServerJobId",type=java.lang.String.class,javaDoc="Holds the viz server job id."),@GeneratedProperty(name="priority",type=java.lang.String.class,javaDoc="Holds the priority of the job.",constraints=@PropertyConstraints(required=true)),@GeneratedProperty(name="dataStorageURL",type=java.lang.String.class,javaDoc="cloud storage location."),@GeneratedProperty(name="fileType",type=java.lang.String.class,javaDoc=" Hold the filetype of job.",constraints=@PropertyConstraints(required=true))},tableProperties=@TableProperties(compositeIndex1="thePersistInfo.theObjectIdentifier.id+statusInfo.code",compositeIndex2="cloudEntryNumber+statusInfo.code+thePersistInfo.modifyStamp")) public class PublishCloudEntry extends wt.viewmarkup._PublishCloudEntry
The PublishCloudEntry represents an individual processing request. Each entry is associated to a cloud entry and can be in one of the following states: SUBMITTED, RETRY, PREPROCESSED, EXECUTING, COMPLETED and FAILED.

Use the newPublishCloudEntry static factory method(s), not the PublishCloudEntry constructor, to construct instances of this class. Instances must be constructed using the static factory(s), in order to ensure proper initialization of the instance.



Supported API: true

Extendable: false

See Also:

  • Field Summary

    Fields inherited from class wt.viewmarkup._PublishCloudEntry

    ARGS, CLOUD_ENTRY_NUMBER, DATA_STORAGE_URL, END_EXEC, ENTRY_OWNER, EXTERNALIZATION_VERSION_UID, FAILURE_COUNT, FILE_TYPE, POSITION, PRIORITY, START_EXEC, STATUS_INFO, VIZ_SERVER_JOB_ID

    Fields inherited from class wt.fc.Item

    SIMPLE_X10_UID, VERSION_40_UID, VERSION_51_UID

    Fields inherited from class wt.fc._WTObject

    CREATE_TIMESTAMP, MODIFY_TIMESTAMP

    Fields inherited from interface wt.fc.adminlock._AdministrativelyLockable

    ADMINISTRATIVE_LOCK

    Fields inherited from interface wt.admin._DomainAdministered

    DOMAIN_REF, INHERITED_DOMAIN

    Fields inherited from interface wt.locks._Lockable

    LOCK, LOCK_DATE, LOCK_NOTE, LOCKED, LOCKER, LOCKER_EMAIL, LOCKER_FULL_NAME, LOCKER_NAME

    Fields inherited from interface wt.fc._Persistable

    PERSIST_INFO

    Fields inherited from interface wt.access._SecurityLabeled

    SECURITY_LABELS

    Fields inherited from interface wt.identity.DisplayIdentification

    DISPLAY_IDENTIFIER, DISPLAY_IDENTITY, DISPLAY_TYPE

    Fields inherited from interface wt.fc.Persistable

    IDENTITY, TYPE

    Fields inherited from interface wt.access.SecurityLabeled

    SECURITY_LABELS_INTERNAL_VALUE

  • Method Summary

    Modifier and Type
    Method
    Description
    WTPrincipal
    getPrincipal()
    Returns the principal that owns the entry's execution.
    protected void
    initialize()
    Supports initialization, following construction of an instance.
    static PublishCloudEntry
    newPublishCloudEntry()
    Constructs a new entry representing a cloud publishing request.

    Methods inherited from class wt.viewmarkup._PublishCloudEntry

    getClassInfo, getCloudEntryNumber, getConceptualClassname, getDataStorageURL, getEndExec, getEntryOwner, getFailureCount, getFileType, getLock, getLockDate, getLocker, getLockerEMail, getLockerFullName, getLockerName, getLockNote, getPosition, getPriority, getStartExec, getStatusInfo, getType, getVizServerJobId, isLocked, readExternal, readExternal, readVersion, setCloudEntryNumber, setDataStorageURL, setEndExec, setEntryOwner, setFailureCount, setFileType, setLock, setPosition, setPriority, setStartExec, setStatusInfo, setVizServerJobId, super_readExternal_PublishCloudEntry, super_readVersion_PublishCloudEntry, super_writeExternal_PublishCloudEntry, writeExternal, writeExternal

    Methods inherited from class wt.fc._Item

    getAdministrativeLock, getDomainRef, getSecurityLabels, isInheritedDomain, readVersion, setAdministrativeLock, setDomainRef, setInheritedDomain, setSecurityLabels, super_readExternal_Item, super_readVersion_Item, super_writeExternal_Item

    Methods inherited from class wt.fc.WTObject

    checkAttributes, duplicate, getDisplayIdentifier, getDisplayIdentity, getDisplayType, getIdentity, toString

    Methods inherited from class wt.fc._WTObject

    equals, getCreateTimestamp, getModifyTimestamp, getPersistInfo, hashCode, readVersion, setPersistInfo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface wt.fc._Persistable

    getPersistInfo, setPersistInfo

    Methods inherited from interface wt.fc.Persistable

    checkAttributes, getIdentity

  • Method Details

    • newPublishCloudEntry

      public static PublishCloudEntry newPublishCloudEntry() throws WTException
      Constructs a new entry representing a cloud publishing request.

      Supported API: true
      Returns:
      PublishCloudEntry
      Throws:
      WTException

    • initialize

      protected void initialize() throws WTException
      Supports initialization, following construction of an instance. Invoked by "new" factory having the same signature.

      Supported API: true
      Overrides:
      initialize in class Item
      Throws:
      WTException

    • getPrincipal

      public WTPrincipal getPrincipal() throws WTException
      Returns the principal that owns the entry's execution. The access control for execution will be enforced relative to this principal.

      Supported API: true
      Returns:
      WTPrincipal
      Throws:
      WTException