Package com.redwood.scheduler.api.model

Interface R2WCatalog

All Superinterfaces:

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

public interface R2WCatalog
extends R2WCatalogComp, UniqueNamedApplicationObject, Readable

The details of the remote R2W catalog.

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "R2WCatalog" 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_PUBLISH	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 , publish , 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 , publish , delete
static String	SEC_RANK_EDIT	This rank is made of the following privileges: create , view , publish , edit
static String	SEC_RANK_NONE	This rank has no privileges assigned to it.
static String	SEC_RANK_PUBLISH	This rank is made of the following privileges: view , publish
static String	SEC_RANK_VIEW	This rank is made of the following privileges: view
static QueryObjectType<R2WCatalog>	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
boolean	approve(UserJobContext context, String reportName, String jobFileExpression, String metaData)	Publish a File, or a list of files to Report2Web for approval
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	checkPublishPrivilege()	Check whether or not the publish action can be performed on this object.
RequiredPermission	checkViewPrivilege()	Check whether or not the view action can be performed on this object.
R2WCatalogAlias	createR2WCatalogAlias()	Create a new R2WCatalogAlias linked to this object.
R2WPublisher	createR2WPublisher(String reportName)	Create a R2WPublisher to assist in publishing to Report2Web.
String	getCatalogName()	Get the value for CatalogName.
String	getPassword()	Get the value for Password.
ProcessServer	getProcessServer()	Get the ProcessServer.
Queue	getQueue()	Get the Queue.
RWIterable<R2WCatalogAlias>	getR2WCatalogAliases()	Get an RWIterable over an ordered collection of R2WCatalogAliases.
String	getURL()	Get the value for URL.
String	getUsername()	Get the value for Username.
void	init()	Perform initialization tasks for the R2W Catalog.
boolean	isUseCredential()	Get the value for UseCredential.
R2WRequest	prepareRequest(String uri)	Prepare an R2WRequest with default (ALL) substitutions.
R2WRequest	prepareRequest(String uri, R2WRequestSubstitutions substitutions)	Prepare an R2WRequest with custom substitutions.
boolean	publish(UserJobContext context, String reportName, String jobFileExpression, String metaData)	Publish a File, or a list of files to Report2Web
void	setCatalogName(String newCatalogName)	Set the value for CatalogName.
void	setPassword(String newPassword)	Set the value for Password.
void	setProcessServer(ProcessServer newProcessServer)	Set the value for ProcessServer.
void	setQueue(Queue newQueue)	Set the value for Queue.
void	setURL(String newURL)	Set the value for URL.
void	setUseCredential(boolean newUseCredential)	Set the value for UseCredential.
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 "R2WCatalog" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<R2WCatalog> 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_PUBLISH

static final String SEC_PRIV_PUBLISH

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_PUBLISH

static final String SEC_RANK_PUBLISH

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

See Also:

Constant Field Values

SEC_RANK_EDIT

static final String SEC_RANK_EDIT

This rank is made of the following privileges: create , view , publish , 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 , publish , 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 , publish , edit , delete

See Also:

Constant Field Values

Method Detail

getURL

String getURL()

Get the value for URL. (The URL of the R2W Server) This value is mandatory, and therefore will not be null if this object has been retrieved from the database.

Returns:

the field

Throws:

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

isUseCredential

boolean isUseCredential()

Get the value for UseCredential. (Use credentials for authentication)

Returns:

the field

Throws:

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. (The username for the connection)

Returns:

the field

Throws:

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. (The password for the connection)

Returns:

the field

Throws:

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

getCatalogName

String getCatalogName()

Get the value for CatalogName. (The optional catalog name, if this is defined it is used when connecting to R2W as the catalog to connect to)

Returns:

the field

Throws:

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

setURL

void setURL(String newURL)

Set the value for URL. (The URL of the R2W Server) This value is mandatory.

Parameters:

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

Throws:

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

setUseCredential

void setUseCredential(boolean newUseCredential)

Set the value for UseCredential. (Use credentials for authentication)

Parameters:

newUseCredential - the new value for UseCredential.

Throws:

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. (The username for the connection) This value is optional.

Parameters:

newUsername - the new value for Username.

Throws:

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. (The password for the connection) This value is optional.

Parameters:

newPassword - the new value for Password.

Throws:

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

setCatalogName

void setCatalogName(String newCatalogName)

Set the value for CatalogName. (The optional catalog name, if this is defined it is used when connecting to R2W as the catalog to connect to) This value is optional.

Parameters:

newCatalogName - the new value for CatalogName.

Throws:

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

publish

boolean publish(UserJobContext context,
                String reportName,
                String jobFileExpression,
                String metaData)

Publish a File, or a list of files to Report2Web

Parameters:

context - The job context to perform the publish

reportName - The name of the Report to publish to

jobFileExpression - The job file expression for the file(s) to publish

metaData - The meta data for the published files

Returns:

Returns if the file(s) were successfully published

createR2WPublisher

R2WPublisher createR2WPublisher(String reportName)

Create a R2WPublisher to assist in publishing to Report2Web.

Parameters:

reportName - The name of the Report to publish to

Returns:

Return a R2WPublisher object to control the publishing process.

approve

boolean approve(UserJobContext context,
                String reportName,
                String jobFileExpression,
                String metaData)

Publish a File, or a list of files to Report2Web for approval

Parameters:

context - The job context to perform the approval under

reportName - The name of the Report to approve

jobFileExpression - The job file expression for the file(s) to approve

metaData - The meta data for the approval files

Returns:

Returns if the file(s) were successfully submitted for approval.

init

void init()

Perform initialization tasks for the R2W Catalog.

prepareRequest

R2WRequest prepareRequest(String uri)
                   throws MalformedURLException

Prepare an R2WRequest with default (ALL) substitutions.

Parameters:

uri - The URI for the request (with or without leading /), the server URL will be prepended.

Returns:

Returns an R2WRequest prepared for the specified server and URL

Throws:

MalformedURLException - The URL is malformed. See java.net.MalformedURLException and java.net.URL for more information.

prepareRequest

R2WRequest prepareRequest(String uri,
                          R2WRequestSubstitutions substitutions)
                   throws MalformedURLException

Prepare an R2WRequest with custom substitutions.

Parameters:

uri - The URI for the request (with or without leading /), the server URL will be prepended.

substitutions - Substitutions

Returns:

Returns an R2WRequest prepared for the specified server and URL

Throws:

MalformedURLException - The URL is malformed. See java.net.MalformedURLException and java.net.URL for more information.

getProcessServer

ProcessServer getProcessServer()

Get the ProcessServer.

Returns:

ProcessServer

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.

getQueue

Queue getQueue()

Get the Queue.

Returns:

Queue

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.

setProcessServer

void setProcessServer(ProcessServer newProcessServer)

Set the value for ProcessServer. This value is mandatory.

Parameters:

newProcessServer - is the object to set ProcessServer to. Link the R2W Catalog to its corresponding process server. If this is null, then the object cannot be persisted.

setQueue

void setQueue(Queue newQueue)

Set the value for Queue. This value is mandatory.

Parameters:

newQueue - is the object to set Queue to. Link the R2W Catalog to its corresponding default queue. If this is null, then the object cannot be persisted.

getR2WCatalogAliases

RWIterable<R2WCatalogAlias> getR2WCatalogAliases()

Get an RWIterable over an ordered collection of R2WCatalogAliases. If the collection is empty, an empty iterator will be returned, that is, this method will never return null. The aliases of a R2W Catalog

Specified by:

getR2WCatalogAliases in interface R2WCatalogComp

Returns:

An RWIterable over an ordered collection of R2WCatalogAlias objects .

createR2WCatalogAlias

R2WCatalogAlias createR2WCatalogAlias()

Create a new R2WCatalogAlias linked to this object.

Returns:

a new R2WCatalogAlias.

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.

checkPublishPrivilege

RequiredPermission checkPublishPrivilege()

Check whether or not the publish 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.