Package com.redwood.scheduler.api.model

Interface SAPArchiveObject

All Superinterfaces:

BusinessKeyObject, Detail, NamedDetailObject, Readable, SAPArchiveObjectComp, SchedulerEntity, SchedulerEntityComp

public interface SAPArchiveObject
extends SAPArchiveObjectComp, NamedDetailObject, BusinessKeyObject, Readable

Archive object.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "SAPArchiveObject" objects.
static String	SEC_RANK_ALL	This rank is made of the following privileges:
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static QueryObjectType<SAPArchiveObject>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

Fields inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

COPYRIGHT_MESSAGE_BKO, ID_BKO

Fields inherited from interface com.redwood.scheduler.api.model.Readable

COPYRIGHT_MESSAGE_E, ID_E

Fields inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

ACTION_AUDIT, ACTION_EXPORT, ACTION_READ, BEHAVIOR_DEPRECATED, BEHAVIOR_NONE, BEHAVIOR_SYSTEM

Method Summary

Modifier and Type	Method	Description
SAPArchiveDocumentType	createSAPArchiveDocumentType()	Create a new SAPArchiveDocumentType linked to this object.
SAPArchiveDocumentType	getSAPArchiveDocumentTypeByName(String name)	Get the SAPArchiveDocumentType by NameSAPArchiveObject.
RWIterable<SAPArchiveDocumentType>	getSAPArchiveDocumentTypes()	Get an RWIterable over an ordered collection of SAPArchiveDocumentTypes.
SAPSystem	getSAPSystem()	Get the SAPSystem.

Methods inherited from interface com.redwood.scheduler.api.model.BusinessKeyObject

getBusinessKey

Methods inherited from interface com.redwood.scheduler.api.model.NamedDetailObject

getComment, getDescription, getName, getSearchName, setComment, setDescription, setName

Methods inherited from interface com.redwood.scheduler.api.model.SchedulerEntity

canPerform, createSubjectObjectPrivilegeGrant, deleteObject, getAuditTrail, getAuditTrailSize, getBehavior, getEffectiveBehavior, getErrorNameEN, getErrorNameKey, getLLPVersion, getLOV, getLOVSupport, getObjectType, getParentSchedulerEntities, getRuntime, getSubjectObjectPrivilegeGrantBySubject, getSubjectObjectPrivilegeGrants, getUniqueId, getUrl, getUrl, isCreated, isDeletable, isDeleted, isModifiable, isModified, isSelectVersioned, processRelatedObjects, processRelatedObjects, processRelatedObjects, refreshObject, resetObject, resetObject, resetValuesToDefault, selectForRead

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

String that will be returned from SchedulerEntity.getObjectType() for "SAPArchiveObject" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<SAPArchiveObject> TYPE

Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges:

See Also:

Constant Field Values

Method Detail

getSAPSystem

SAPSystem getSAPSystem()

Get the SAPSystem.

Returns:

SAPSystem

Throws:

ObjectDeletedException - If this method is called when the object has been marked for deletion.

ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

getSAPArchiveDocumentTypes

RWIterable<SAPArchiveDocumentType> getSAPArchiveDocumentTypes()

Get an RWIterable over an ordered collection of SAPArchiveDocumentTypes. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. Document type supported by a SAP archive object.

Specified by:

getSAPArchiveDocumentTypes in interface SAPArchiveObjectComp

Returns:

An RWIterable over an ordered collection of SAPArchiveDocumentType objects .

createSAPArchiveDocumentType

SAPArchiveDocumentType createSAPArchiveDocumentType()

Create a new SAPArchiveDocumentType linked to this object.

Returns:

a new SAPArchiveDocumentType.

getSAPArchiveDocumentTypeByName

SAPArchiveDocumentType getSAPArchiveDocumentTypeByName(String name)

Get the SAPArchiveDocumentType by NameSAPArchiveObject.

Parameters:

name -

Returns:

the SAPArchiveDocumentType, or null if it could not be found