Package com.redwood.scheduler.api.model

Interface RemoteSystem

All Superinterfaces:

ApplicationObject, BusinessKeyObject, NamedRootObject, NamedRootObjectComp, PartitionableObject, PartitionableObjectComp, Readable, Root, SchedulerEntity, SchedulerEntityComp, UniqueNamedApplicationObject

public interface RemoteSystem
extends UniqueNamedApplicationObject, Readable

Remote System describes another scheduler instance that this system cann connect to or receive connections from.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "RemoteSystem" objects.
static String	SEC_PRIV_CREATE	This privilege can be granted at a group level.
static String	SEC_PRIV_DELETE	This privilege can be granted at a group level.
static String	SEC_PRIV_EDIT	This privilege can be granted at a group level.
static String	SEC_PRIV_USE	This privilege can be granted at an instance level.
static String	SEC_PRIV_VIEW	This privilege can be granted at a group level.
static String	SEC_RANK_ALL	This rank is made of the following privileges: create , view , use , edit , delete
static String	SEC_RANK_CREATE	This rank is made of the following privileges: create
static String	SEC_RANK_DELETE	This rank is made of the following privileges: create , view , delete
static String	SEC_RANK_EDIT	This rank is made of the following privileges: create , view , use , edit
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static String	SEC_RANK_USE	This rank is made of the following privileges: view , use
static String	SEC_RANK_VIEW	This rank is made of the following privileges: view
static QueryObjectType<RemoteSystem>	TYPE	Type that can be used in SchedulerSession.executeObjectQuery(QueryObjectType, String, Object...).

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
RequiredPermission	checkCreatePrivilege()	Check whether or not the create action can be performed on this object.
RequiredPermission	checkDeletePrivilege()	Check whether or not the delete action can be performed on this object.
RequiredPermission	checkEditPrivilege()	Check whether or not the edit action can be performed on this object.
RequiredPermission	checkUsePrivilege()	Check whether or not the use action can be performed on this object.
RequiredPermission	checkViewPrivilege()	Check whether or not the view action can be performed on this object.
ImportRuleSet	getImportRuleSet()	Get the ImportRuleSet.
String	getLocation()	Get the value for Location.
String	getOptions()	Get the value for Options.
String	getPassword()	Get the value for Password.
JobDefinition	getPromoteFurtherJobDefinition()	Get the PromoteFurtherJobDefinition.
JobDefinition	getPushAcceptorJobDefinition()	Get the PushAcceptorJobDefinition.
JobDefinition	getPusherJobDefinition()	Get the PusherJobDefinition.
RemoteSystemType	getType()	Get the value for Type.
String	getUsername()	Get the value for Username.
boolean	isAllowRuleSetOverride()	Get the value for AllowRuleSetOverride.
void	setAllowRuleSetOverride(boolean newAllowRuleSetOverride)	Set the value for AllowRuleSetOverride.
void	setImportRuleSet(ImportRuleSet newImportRuleSet)	Set the value for ImportRuleSet.
void	setLocation(String newLocation)	Set the value for Location.
void	setOptions(String newOptions)	Set the value for Options.
void	setPassword(String newPassword)	Set the value for Password.
void	setPromoteFurtherJobDefinition(JobDefinition newPromoteFurtherJobDefinition)	Set the value for PromoteFurtherJobDefinition.
void	setPushAcceptorJobDefinition(JobDefinition newPushAcceptorJobDefinition)	Set the value for PushAcceptorJobDefinition.
void	setPusherJobDefinition(JobDefinition newPusherJobDefinition)	Set the value for PusherJobDefinition.
void	setType(RemoteSystemType newType)	Set the value for Type.
void	setUsername(String newUsername)	Set the value for Username.

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

getParentApplication, setParentApplication

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

getBusinessKey

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.PartitionableObject

createObjectTag, getEditablePartitions, getObjectTagByObjectTagDefinition, getObjectTags, getPartition, setPartition

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

Field Detail

OBJECT_TYPE

static final String OBJECT_TYPE

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

See Also:

Constant Field Values

TYPE

static final QueryObjectType<RemoteSystem> TYPE

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

SEC_PRIV_CREATE

static final String SEC_PRIV_CREATE

This privilege can be granted at a group level.

See Also:

Constant Field Values

SEC_PRIV_VIEW

static final String SEC_PRIV_VIEW

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_USE

static final String SEC_PRIV_USE

This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_EDIT

static final String SEC_PRIV_EDIT

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_PRIV_DELETE

static final String SEC_PRIV_DELETE

This privilege can be granted at a group level. This privilege can be granted at an instance level.

See Also:

Constant Field Values

SEC_RANK_NONE

static final String SEC_RANK_NONE

This rank has no privileges assigned to it.

See Also:

Constant Field Values

SEC_RANK_CREATE

static final String SEC_RANK_CREATE

This rank is made of the following privileges: create

See Also:

Constant Field Values

SEC_RANK_VIEW

static final String SEC_RANK_VIEW

This rank is made of the following privileges: view

See Also:

Constant Field Values

SEC_RANK_USE

static final String SEC_RANK_USE

This rank is made of the following privileges: view , use

See Also:

Constant Field Values

SEC_RANK_EDIT

static final String SEC_RANK_EDIT

This rank is made of the following privileges: create , view , use , edit

See Also:

Constant Field Values

SEC_RANK_DELETE

static final String SEC_RANK_DELETE

This rank is made of the following privileges: create , view , delete

See Also:

Constant Field Values

SEC_RANK_ALL

static final String SEC_RANK_ALL

This rank is made of the following privileges: create , view , use , edit , delete

See Also:

Constant Field Values

Method Detail

getLocation

String getLocation()

Get the value for Location. (Location url where the remote system can be reached.)

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.

getUsername

String getUsername()

Get the value for Username. (Name of the user to use to login.)

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.

getPassword

String getPassword()

Get the value for Password. (Password of the user to use to login.)

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.

getType

RemoteSystemType getType()

Get the value for Type. (What is the type of the remote system.) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

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.

isAllowRuleSetOverride

boolean isAllowRuleSetOverride()

Get the value for AllowRuleSetOverride. (Is it allowed for the import to override the Import Rule Set.)

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.

getOptions

String getOptions()

Get the value for Options. (This field is only valid when the Remote System type is Destination or Both, and would contain command line parameters in the same format as accepted by the command line tool.)

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.

setLocation

void setLocation(String newLocation)

Set the value for Location. (Location url where the remote system can be reached.) This value is optional.

Parameters:

newLocation - the new value for Location.

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.

setUsername

void setUsername(String newUsername)

Set the value for Username. (Name of the user to use to login.) This value is optional.

Parameters:

newUsername - the new value for Username.

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.

setPassword

void setPassword(String newPassword)

Set the value for Password. (Password of the user to use to login.) This value is optional.

Parameters:

newPassword - the new value for Password.

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.

setType

void setType(RemoteSystemType newType)

Set the value for Type. (What is the type of the remote system.) This value is mandatory.

Parameters:

newType - the new value for Type. If this is null, then the object cannot be persisted.

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.

setAllowRuleSetOverride

void setAllowRuleSetOverride(boolean newAllowRuleSetOverride)

Set the value for AllowRuleSetOverride. (Is it allowed for the import to override the Import Rule Set.)

Parameters:

newAllowRuleSetOverride - the new value for AllowRuleSetOverride.

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.

setOptions

void setOptions(String newOptions)

Set the value for Options. (This field is only valid when the Remote System type is Destination or Both, and would contain command line parameters in the same format as accepted by the command line tool.) This value is optional.

Parameters:

newOptions - the new value for Options.

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.

getPushAcceptorJobDefinition

JobDefinition getPushAcceptorJobDefinition()

Get the PushAcceptorJobDefinition.

Returns:

PushAcceptorJobDefinition

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.

getPusherJobDefinition

JobDefinition getPusherJobDefinition()

Get the PusherJobDefinition.

Returns:

PusherJobDefinition

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.

getPromoteFurtherJobDefinition

JobDefinition getPromoteFurtherJobDefinition()

Get the PromoteFurtherJobDefinition.

Returns:

PromoteFurtherJobDefinition

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.

getImportRuleSet

ImportRuleSet getImportRuleSet()

Get the ImportRuleSet.

Returns:

ImportRuleSet

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.

setPushAcceptorJobDefinition

void setPushAcceptorJobDefinition(JobDefinition newPushAcceptorJobDefinition)

Set the value for PushAcceptorJobDefinition. This value is optional.

Parameters:

newPushAcceptorJobDefinition - is the object to set PushAcceptorJobDefinition to. The job definition that is used to import an archive when using promotion.

setPusherJobDefinition

void setPusherJobDefinition(JobDefinition newPusherJobDefinition)

Set the value for PusherJobDefinition. This value is optional.

Parameters:

newPusherJobDefinition - is the object to set PusherJobDefinition to. The jobdefinition that is used to export an archive when using promotion.

setPromoteFurtherJobDefinition

void setPromoteFurtherJobDefinition(JobDefinition newPromoteFurtherJobDefinition)

Set the value for PromoteFurtherJobDefinition. This value is optional.

Parameters:

newPromoteFurtherJobDefinition - is the object to set PromoteFurtherJobDefinition to. The jobdefinition that is used to promote an archive when using promote further.

setImportRuleSet

void setImportRuleSet(ImportRuleSet newImportRuleSet)

Set the value for ImportRuleSet. This value is optional.

Parameters:

newImportRuleSet - is the object to set ImportRuleSet to. The Import Rule Set that is going to be applied when a remote system is pushing a car file.

checkCreatePrivilege

RequiredPermission checkCreatePrivilege()

Check whether or not the create action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkViewPrivilege

RequiredPermission checkViewPrivilege()

Check whether or not the view action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkUsePrivilege

RequiredPermission checkUsePrivilege()

Check whether or not the use action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkEditPrivilege

RequiredPermission checkEditPrivilege()

Check whether or not the edit action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.

checkDeletePrivilege

RequiredPermission checkDeletePrivilege()

Check whether or not the delete action can be performed on this object.

Returns:

a RequiredPermission instance indicating whether the current user has the privilege. To check this, use isAllowed() on the returned permission.