Package com.redwood.scheduler.api.model

Interface PublishedWebService

All Superinterfaces:

Detail, NamedDetailObject, Readable, SchedulerEntity, SchedulerEntityComp

public interface PublishedWebService
extends NamedDetailObject, Readable

An object used to flag which JobDefinitions are published as web services. Requires a PublishedWebService license A JobDefinition can be called via a SOAP Request only if it is declared in one of these objects

Field Summary

Fields

Modifier and Type	Field	Description
static String	OBJECT_TYPE	String that will be returned from SchedulerEntity.getObjectType() for "PublishedWebService" 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<PublishedWebService>	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
Long	getBranchedLLPVersion()	Get the value for BranchedLLPVersion.
JobDefinition	getJobDefinition()	Get the JobDefinition.
String	getWSDL_URL()	Get the value for WSDL_URL.
String	getWSURL()	Get the value for WSURL.
boolean	isAddJobNote()	Get the value for AddJobNote.
boolean	isEnabled()	Get the value for Enabled.
void	setAddJobNote(boolean newAddJobNote)	Set the value for AddJobNote.
void	setEnabled(boolean newEnabled)	Set the value for Enabled.
void	setWSURL(String newWSURL)	Set the value for WSURL.

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 "PublishedWebService" objects.

See Also:

Constant Field Values

TYPE

static final QueryObjectType<PublishedWebService> 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

getWSURL

String getWSURL()

Get the value for WSURL. (The URL that the WebService is published on. e.g. http://192.169.7.5:7777. Defaults to the hostname:port where the WebService was published if not 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.

getWSDL_URL

String getWSDL_URL()

Get the value for WSDL_URL. (The URL that the WSDL is published on. Calculated from the WSURL)

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.

isAddJobNote

boolean isAddJobNote()

Get the value for AddJobNote. (Whether to add a JobNote on submit.)

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.

isEnabled

boolean isEnabled()

Get the value for Enabled. (Whether this webservice is currently enabled or not.)

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.

getBranchedLLPVersion

Long getBranchedLLPVersion()

Get the value for BranchedLLPVersion. (LLP version from which this object was created.) 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.

setWSURL

void setWSURL(String newWSURL)

Set the value for WSURL. (The URL that the WebService is published on. e.g. http://192.169.7.5:7777. Defaults to the hostname:port where the WebService was published if not set.) This value is optional.

Parameters:

newWSURL - the new value for WSURL.

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.

setAddJobNote

void setAddJobNote(boolean newAddJobNote)

Set the value for AddJobNote. (Whether to add a JobNote on submit.)

Parameters:

newAddJobNote - the new value for AddJobNote.

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.

setEnabled

void setEnabled(boolean newEnabled)

Set the value for Enabled. (Whether this webservice is currently enabled or not.)

Parameters:

newEnabled - the new value for Enabled.

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.

getJobDefinition

JobDefinition getJobDefinition()

Get the JobDefinition.

Returns:

JobDefinition

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.