Package com.redwood.scheduler.api.model

Interface PartitionableObject

All Superinterfaces:

NamedRootObject, NamedRootObjectComp, PartitionableObjectComp, Root, SchedulerEntity, SchedulerEntityComp

All Known Subinterfaces:

AdHocAlertSource, AlertEscalation, AlertGateway, AlertSource, Application, ApplicationObject, BranchedUniqueNamedApplicationObject, ConstraintDefinition, CredentialProtocol, Dashboard, Database, DatumDefinition, Document, EmailAlertGateway, EventDefinition, ExportRuleSet, ExtensionPoint, Format, ImportRuleDefinition, ImportRuleSet, ImportSource, JobDefinition, JobDefinitionAlertSource, JobDefinitionType, JobLock, Library, MailConnector, MonitorAlertSource, NavigationBar, ObjectTagDefinition, OraAppsSystem, OraOhiSystem, PeopleSoftSystem, PeriodFunction, ProcessMonitor, ProcessMonitorDefinition, ProcessServer, ProcessServerAlertSource, Queue, QueueAlertSource, R2WCatalog, RemoteSystem, Resource, SAPBAEConnector, SAPSystem, Service, SubmitFrame, Table, TableDefinition, TimeWindow, Trigger, UniqueNamedApplicationObject

public interface PartitionableObject
extends PartitionableObjectComp, NamedRootObject

All partitionable objects Base class for objects that have a partition.

Field Summary

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
ObjectTag	createObjectTag(ObjectTagDefinition objectTagDefinition)	Create a new ObjectTag for this PartitionableObject based on given ObjectTagDefinition.
Set<Long>	getEditablePartitions()	Return the UniqueIds of all partitions to which the current user can write entities of the current type.
ObjectTag	getObjectTagByObjectTagDefinition(ObjectTagDefinition objectTagDefinition)	Get the ObjectTag for given ObjectTagDefinition that is associated with this PartitionableObject.
RWIterable<ObjectTag>	getObjectTags()	Get the value for ObjectTag.
Partition	getPartition()	Get the Partition.
void	setPartition(Partition newPartition)	Set the value for Partition.

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

createObjectReference, getComment, getDescription, getLinkedObjectReferenceByLinkedObject, getLinkedObjectReferenceByName, getLinkedObjectReferences, getName, getSearchName, getSourceObjectReferences, isHidden, setComment, setDescription, setName

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

getCreationTime, getLastModificationTime, getLastModifierSubject

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

Method Detail

getObjectTags

RWIterable<ObjectTag> getObjectTags()

Get the value for ObjectTag. (Get all object tags created for this PartitionableObject)

Specified by:

getObjectTags in interface PartitionableObjectComp

Returns:

the field

Throws:

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - This will be thrown if this method is called while the object is not attached to a session.

getEditablePartitions

Set<Long> getEditablePartitions()

Return the UniqueIds of all partitions to which the current user can write entities of the current type.

Returns:

All editable partitions.

createObjectTag

ObjectTag createObjectTag(ObjectTagDefinition objectTagDefinition)

Create a new ObjectTag for this PartitionableObject based on given ObjectTagDefinition.

Parameters:

objectTagDefinition - The ObjectTagDefinition the ObjectTag is based on.

Returns:

Return the newly created ObjectTag

getObjectTagByObjectTagDefinition

ObjectTag getObjectTagByObjectTagDefinition(ObjectTagDefinition objectTagDefinition)

Get the ObjectTag for given ObjectTagDefinition that is associated with this PartitionableObject. Will return the ObjectTag when present, null otherwise.

Parameters:

objectTagDefinition - The ObjectTagDefinition.

Returns:

The ObjectTag associated to the PartitionableObject if found, null otherwise.

getPartition

Partition getPartition()

Get the Partition.

Returns:

Partition

Throws:

com.redwood.scheduler.api.exception.ObjectDeletedException - If this method is called when the object has been marked for deletion.

com.redwood.scheduler.api.exception.ObjectNotAttachedToSessionException - If this method is called when the object has been removed from it's session.

setPartition

void setPartition(Partition newPartition)

Set the value for Partition. This value is mandatory.

Parameters:

newPartition - is the object to set Partition to. The objects in this partition. If this is null, then the object cannot be persisted.