Uses of Class
com.uc4.api.UC4ObjectName

Packages that use UC4ObjectName

Package	Description
com.uc4.api
com.uc4.api.objects
com.uc4.api.prompt
com.uc4.api.systemoverview
com.uc4.communication
com.uc4.communication.requests

Uses of UC4ObjectName in com.uc4.api

Subclasses of UC4ObjectName in com.uc4.api

Modifier and Type	Class	Description
final class	UC4HostName	This class represents name of an Agent.
class	UC4TimezoneName	This class represents the name of a TimeZone object.
class	UC4UserName	This class represents the name of a USER object.

Methods in com.uc4.api that return UC4ObjectName

Modifier and Type	Method	Description
UC4ObjectName	ComponentWorkflowObjectName.getName()	Returns the object name of the template.
UC4ObjectName	StorageItem.getName()	Returns name of the resource.
UC4ObjectName	TaskPromptSetName.getName()	Returns the name of the Prompt Set.
UC4ObjectName	VersionControlListItem.getSavedName()	Returns the generated name of the revision.

Methods in com.uc4.api with parameters of type UC4ObjectName

Modifier and Type	Method	Description
void	TaskFilter.addQueueFilter(UC4ObjectName queue)	Adds a new item to the filter for Queues.
void	TaskFilter.addQueueFilter(UC4ObjectName queue, int client)	Adds a certain Queue and a client to the filter for Queues.
void	TaskFilter.setQueueFilter(UC4ObjectName queue)	Sets a filter for Queues.
void	TaskFilter.setQueueFilter(UC4ObjectName queue, int client)	Sets a filter for a certain Queue and a client.

Constructors in com.uc4.api with parameters of type UC4ObjectName

Modifier	Constructor	Description
	ComponentWorkflowObjectName(UC4ObjectName name, String title)	Creates a new ComponentTemplate instance.
	ComponentWorkflowObjectName(UC4ObjectName name, String title, String wfType)	Creates a new ComponentTemplate instance.
	UC4ObjectName(UC4ObjectName name)	This constructor is required for creating copy of UC4ObjectName

Uses of UC4ObjectName in com.uc4.api.objects

Methods in com.uc4.api.objects that return UC4ObjectName

Modifier and Type	Method	Description
UC4ObjectName	SAPAgentPanel.getAbapConnection()
UC4ObjectName	JobPlanExternal.getAlarmObject()	Returns the name of the alarm object.
UC4ObjectName	DatabaseConnection.getAlternativeLogin()
UC4ObjectName	Rollback.getBackupObject()	Returns the UC4 Object for the backup or an empty instance if not set.
UC4ObjectName	Group.getChildrenQueue()	Deprecated. use attributes.getChildrenQueue of this group instead
UC4ObjectName	GroupAttributes.getChildrenQueue()	Returns the name of the Queue Object for children of this Group.
UC4ObjectName	JobPlanAttributes.getChildrenQueue()	Returns the name of the Queue Object for children of this ProcessFlow.
UC4ObjectName	ScheduleAttributes.getChildrenQueue()	Returns the name of the Queue Object for children of this Schedule.
UC4ObjectName	JobAttributes.getCodeName()	Returns the name of the CodeTable.
UC4ObjectName	AttributesSQL.getConnection()	Returns the name of the connection object.
UC4ObjectName	CheckConnectionCondition.getConnection()
UC4ObjectName	DynamicSQLVariable.getConnection()	Returns the name of the connection object.
UC4ObjectName	SecureSQLVariable.getConnection()	Returns the name of the connection object.
UC4ObjectName	UserAttributes.getDefaultLogin()	Returns the Login object for the database access of Variable objects with the source "SQL".
UC4ObjectName	FileTransferSettings.getDestinationCodeTable()
UC4ObjectName	FileTransferSettings.getDestinationLogin()
UC4ObjectName	JobPlanDependencies.getElseExecute()	Returns the object that should be executed when a defined condition does not occur.
UC4ObjectName	QueueManagerAttributes.getElseExecute()	Returns the object name of the object that is executed when a task ends with a Return Code greater than the max expected return code.
UC4ObjectName	NotificationAttributes.getEscalationCallOperator()	Returns the escalation Notification.
UC4ObjectName	DynamicExecVariable.getExecObject()	Gets the executable object name.
UC4ObjectName	JobPlanCheckpoint.getExecute()	Deprecated. Returns the name of the object that is to be started when the checkpoint has been exceeded.
UC4ObjectName	ProcessFlowGeneral.getExecute()	Returns the name of the object that is to be started when the checkpoint has been exceeded.
UC4ObjectName	OutputScanFilter.getExecuteObject()	Returns the name of the Automation Engine object which should be executed if the filter matches.
UC4ObjectName	Runtime.getExecuteObject()	Returns the object which is executed when the runtime exceeds or falls below the specified limits.
UC4ObjectName	TaskResult.getExecuteObject()	Returns the object that is to be started when the specified status is not reached.
UC4ObjectName	TaskRuntime.getExecuteObject()	Returns the object which is executed when the runtime exceeds or falls below the specified limits.
UC4ObjectName	JobPlanExternal.getExternalParent()	Returns the parent of the external task.
UC4ObjectName	OutputScanFilter.getFilterName()	Name of the filter object.
UC4ObjectName	SAPAgentPanel.getJavaConnection()
UC4ObjectName	CalendarCondition.getKeyword()	Returns the calendar keyword.
UC4ObjectName	BackendVariable.getLogin()	Returns the name of the LOGIN object.
UC4ObjectName	CheckFileCondition.getLogin()	Returns the name of the Login object.
UC4ObjectName	CheckProcessCondition.getLogin()
UC4ObjectName	DynamicSQLVariable.getLogin()
UC4ObjectName	FileListVariable.getLogin()	Returns the name of the LOGIN object.
UC4ObjectName	FileSystem.getLogin()	Returns the name of the login object assigned "FileSystem" tab of an file event object.
UC4ObjectName	JobAttributes.getLogin()	Returns the name of the login object assigned to this job.
UC4ObjectName	OutputScan.getLogin()	Returns the name of the login object which is used for external file scans.
UC4ObjectName	SAPConnectionHTTP.getLogin()	Returns the Login
UC4ObjectName	SAPConnectionRFC.getLogin()	Returns the Login
UC4ObjectName	SecureSQLVariable.getLogin()
UC4ObjectName	ConsoleSAP.getLoginName()
UC4ObjectName	DatabaseEventValue.getLoginObject()
UC4ObjectName	CalendarCondition.getName()	Returns the name of the Calendar.
UC4ObjectName	CalendarKeyword.getName()	Returns the name of the Calendar Keyword.
UC4ObjectName	CheckActivitiesCondition.getName()
UC4ObjectName	CheckHistoryCondition.getName()
UC4ObjectName	ExecuteObjectAction.getName()
UC4ObjectName	ExecuteRecurring.getName()	Returns the name or null if it has not been set.
UC4ObjectName	ObjectRight.getName()	Returns the UC4UserName (User) or UC4ObjectName (UserGroup) for the ObjectRight.
UC4ObjectName	PromptSetDefinition.getName()
UC4ObjectName	JobPlanAttributes.getOkStateExecute()	Returns the object that is executed when a task does not have the expected end status.
UC4ObjectName	ScheduleAttributes.getOkStateExecute()	Returns the object that is executed when a task does not have the expected end status.
UC4ObjectName	SloFulfillment.getOnFulfillmentObject()	Returns the name of the object which is executed on fulfillment.
UC4ObjectName	SloFulfillment.getOnViolationObject()	Returns the name of the object which is executed on violation.
UC4ObjectName	ICallOperatorCondition.getOperatorName()	Returns the name or UserGroup of the Operator which should be notified.
UC4ObjectName	ChangeQueueAction.getQueue()
UC4ObjectName	EventAttributes.getQueue()	Returns the Queue Object.
UC4ObjectName	ExecuteRecurring.getQueue()	Returns the Queue Object.
UC4ObjectName	FileTransferAttributes.getQueue()	Returns the name of the Queue Object.
UC4ObjectName	Group.getQueue()	Deprecated. use attributes.getQueue of this group instead
UC4ObjectName	GroupAttributes.getQueue()	Returns the Queue Object.
UC4ObjectName	JobAttributes.getQueue()	Returns the Queue Object.
UC4ObjectName	JobPlanAttributes.getQueue()	Returns the Queue Object.
UC4ObjectName	NotificationAttributes.getQueue()	Returns the Queue Object.
UC4ObjectName	QueueManagerAttributes.getQueue()	Returns the Queue Object.
UC4ObjectName	ScheduleAttributes.getQueue()	Returns the Queue Object.
UC4ObjectName	ScriptAttributes.getQueue()	Returns the Queue Object.
UC4ObjectName	CurrentQueueCondition.getQueueName()
UC4ObjectName	Runtime.getRetCodeExecuteObject()	Returns the name of the Automation Engine Object which should be executed when the actual return code is higher than the maximum allowed return code.
UC4ObjectName	Rollback.getRollbackObject()	Returns the UC4 Object for rollback.
UC4ObjectName	SAPAgentPanel.getSdlConnection()
UC4ObjectName	FileTransferSettings.getSourceCodeTable()
UC4ObjectName	FileTransferSettings.getSourceLogin()
UC4ObjectName	EventAttributes.getStartType()	Returns the start type of this Job.
UC4ObjectName	FileTransferAttributes.getStartType()	Returns the start type of this Job.
UC4ObjectName	JobAttributes.getStartType()	Returns the start type of this Job.
UC4ObjectName	JobPlanAttributes.getStartType()	Returns the start type of this JobPlan.
UC4ObjectName	NotificationAttributes.getStartType()	Returns the start type of this Notification.
UC4ObjectName	ScheduleAttributes.getStartType()	Returns the start type of this job.
UC4ObjectName	ScriptAttributes.getStartType()	Returns the start type of this Script.
UC4ObjectName	RuleEventSetting.getStoreName()	Provides the Store object which this Event is linked to.
UC4ObjectName	SyncItem.getSyncObject()	Returns the name of a Sync object with which the task should be synchronized.
UC4ObjectName	CompositeVariable.getVariable1()	Returns the name of the first variable.
UC4ObjectName	CompositeVariable.getVariable2()	Returns the name of the first variable.
UC4ObjectName	DatabaseEventValue.getVariableKeyword()	Deprecated. : variableKeyowrd type changed from UC4ObjectName to String.
UC4ObjectName	ClearVariableAction.getVariableName()	Returns the name of the Variable object.
UC4ObjectName	DatabaseEventValue.getVariableName()
UC4ObjectName	LoopDataSource.getVariableName()	Returns the name of the UC4 VARA Object.
UC4ObjectName	SetVariableAction.getVariableName()
UC4ObjectName	SAPAgentPanel.getXiConnection()

Methods in com.uc4.api.objects that return types with arguments of type UC4ObjectName

Modifier and Type	Method	Description
Iterator<UC4ObjectName>	UserGroupAssignment.memberListIterator()	Returns a list of the client's user groups in which the user is a member.
Iterator<UC4ObjectName>	UserGroupAssignment.noMemberListIterator()	Returns a list of the client's user groups in which the user is not a member.

Methods in com.uc4.api.objects with parameters of type UC4ObjectName

Modifier and Type	Method	Description
void	Operator.addOperator(UC4ObjectName operator)	Adds a new Operator without a calendar condition.
void	Operator.addOperator(UC4ObjectName operator, CalendarCondition condition)	Adds a new Operator which is notified on the specified calendar condition.
boolean	UserGroupAssignment.addUserToGroup(UC4ObjectName userGroup)	Adds this User to the specified User Group.
static JobPlanTask	ObjectFactory.createExternalWorkflowTask(UC4ObjectName name, UC4ObjectName externalParent)	Creates a new external Workflow task.
static JobPlanTask	ObjectFactory.createWorkflowTask(UC4ObjectName name, String objectType)	Creates a new Workflow task.
CalendarKeyword	Calendar.getCalendarkeyword(UC4ObjectName keyword)	Gets the specified calendar keyword from this calendar.
boolean	Calendar.removeKeyword(UC4ObjectName keyword)	Removes the specified calendar keyword from this calendar It is not possible to remove all keywords.
boolean	Operator.removeOperator(UC4ObjectName operator)	Removes the specified Operator from this Notification.
boolean	UserGroupAssignment.removeUserGroup(UC4ObjectName userGroup)	Removes this User from the specified User Group.
void	LoopDataSource.selectSourceVariable(UC4ObjectName vara, int column)	Selects a VARA Object as datasource.
void	SAPAgentPanel.setAbapConnection(UC4ObjectName abapConnection)	Sets the ABAP Connection Object.
void	JobPlanExternal.setAlarmObject(UC4ObjectName alarmObject)	Sets the alarm object.
void	DatabaseConnection.setAlternativeLogin(UC4ObjectName alternativeLogin)	Sets an alternative Login Object.
void	Rollback.setBackupObject(UC4ObjectName backupObject)	Sets the UC4 object for backup.
void	Group.setChildrenQueue(UC4ObjectName childrenQueue)	Deprecated. use attributes.setChildrenQueue of this group instead
void	GroupAttributes.setChildrenQueue(UC4ObjectName childrenQueue)	Sets the name of the Queue Object for children of this Group.
void	JobPlanAttributes.setChildrenQueue(UC4ObjectName childrenQueue)	Sets the name of the Queue Object for children of this ProcessFlow.
void	ScheduleAttributes.setChildrenQueue(UC4ObjectName childrenQueue)	Sets the name of the Queue Object for children of this Schedule.
void	JobAttributes.setCodeName(UC4ObjectName codeTable)	Sets the name of the CodeTable.
void	AttributesSQL.setConnection(UC4ObjectName connection)	Sets the connection object.
void	CheckConnectionCondition.setConnection(UC4ObjectName connection)
void	DynamicSQLVariable.setConnection(UC4ObjectName connection)	Sets the connection object.
void	SecureSQLVariable.setConnection(UC4ObjectName connection)	Sets the connection object.
void	UserAttributes.setDefaultLogin(UC4ObjectName defaultLogin)	Sets the Login object for the database access of Variable objects with the source "SQL".
void	FileTransferSettings.setDestinationCodeTable(UC4ObjectName destinationCodeTable)	Sets the CodeTable for all destination files.
void	FileTransferSettings.setDestinationLogin(UC4ObjectName destinationLogin)	Sets the name fo the Login Object which should be used by source Agent.
void	JobPlanDependencies.setElseExecute(UC4ObjectName elseExecute)	Sets the object that should be executed when a defined condition does not occur.
void	QueueManagerAttributes.setElseExecute(UC4ObjectName elseExecute)	Sets the object that is executed when a task has a Return Code greater or equal the than the max expected return code.
void	NotificationAttributes.setEscalationCallOperator(UC4ObjectName escalationCallOperator)	Sets an additional Notification which will be activated if the controlling operator does not respond.
void	DynamicExecVariable.setExecObject(UC4ObjectName execObject)	Sets the executable object name.
void	JobPlanCheckpoint.setExecute(UC4ObjectName execute)	Deprecated. Sets the name of the object that is to be started when the checkpoint has been exceeded.
void	ProcessFlowGeneral.setExecute(UC4ObjectName execute)	Sets the name of the object that is to be started when the checkpoint has been exceeded.
void	Runtime.setExecuteObject(UC4ObjectName executeObject)	Sets the object which is executed when the runtime exceeds or falls below the specified limits.
void	TaskResult.setExecuteObject(UC4ObjectName executeObject)	Returns the object that is to be started when the specified status is not reached.
void	TaskRuntime.setExecuteObject(UC4ObjectName executeObject)	Sets the object which is executed when the runtime exceeds or falls below the specified limits.
void	JobPlanExternal.setExternalParent(UC4ObjectName externalParent)	Sets the parent of the external task.
void	SAPAgentPanel.setJavaConnection(UC4ObjectName javaConnection)
void	BackendVariable.setLogin(UC4ObjectName login)	Sets the name of the LOGIN object.
void	CheckFileCondition.setLogin(UC4ObjectName login)	Sets the name of the Login object that is used to check if the file exists.
void	CheckProcessCondition.setLogin(UC4ObjectName login)
void	DynamicSQLVariable.setLogin(UC4ObjectName login)	Sets the name of the login object.
void	FileListVariable.setLogin(UC4ObjectName login)	Sets the name of the LOGIN object.
void	FileSystem.setLogin(UC4ObjectName loginObject)	Sets the name of the login object this field just effect on HostType WIN, UNIX Os/390 (MVS).
void	JobAttributes.setLogin(UC4ObjectName loginObject)	Sets the name of the login object.
void	OutputScan.setLogin(UC4ObjectName login)	Sets the login object for the specified host.
void	SAPConnectionHTTP.setLogin(UC4ObjectName login)	Sets the login.
void	SAPConnectionRFC.setLogin(UC4ObjectName login)	Sets the login.
void	SecureSQLVariable.setLogin(UC4ObjectName login)	Sets the name of the login object.
void	ConsoleSAP.setLoginName(UC4ObjectName loginName)	Sets the name of the login object.
void	CalendarKeyword.setName(UC4ObjectName name)	Sets the name of the Calendar Keyword.
void	CheckActivitiesCondition.setName(UC4ObjectName name)
void	CheckHistoryCondition.setName(UC4ObjectName name)
void	ExecuteObjectAction.setName(UC4ObjectName name)	Sets the name of the Automation Engine object.
void	ObjectRight.setName(UC4ObjectName name)	Sets the name for the ObjectRight.
void	JobPlanAttributes.setOkStateExecute(UC4ObjectName okStateExecute)	Sets the object that is executed when a task does not have the expected end status.
void	ScheduleAttributes.setOkStateExecute(UC4ObjectName okStateExecute)	Sets the object that is executed when a task does not have the expected end status.
void	SloFulfillment.setOnFulfillmentObject(UC4ObjectName onFulfillmentObject)	Sets the name of the object which is executed on fulfillment.
void	SloFulfillment.setOnViolationObject(UC4ObjectName onViolationObject)	Sets the name of the object which is executed on violation.
void	ChangeQueueAction.setQueue(UC4ObjectName queue)
void	EventAttributes.setQueue(UC4ObjectName queue)	Sets the Queue that will be used when this object is executed.
void	ExecuteRecurring.setQueue(UC4ObjectName queue)	Sets the Queue that will be used when this Automation Engine object is executed.
void	FileTransferAttributes.setQueue(UC4ObjectName queue)	Sets the name of the Queue.
void	Group.setQueue(UC4ObjectName queue)	Deprecated. use attributes.setQueue of this group instead
void	GroupAttributes.setQueue(UC4ObjectName queue)	Sets the Queue that will be used when this Automic object is executed.
void	JobAttributes.setQueue(UC4ObjectName queue)	Sets the Queue that will be used when this object is executed.
void	JobPlanAttributes.setQueue(UC4ObjectName queue)	Sets the Queue that will be used when this object is executed.
void	NotificationAttributes.setQueue(UC4ObjectName queue)	Sets the Queue that will be used when this object is executed.
void	QueueManagerAttributes.setQueue(UC4ObjectName queue)	Sets the Queue that will be used when this the Automation Engine object is executed.
void	ScheduleAttributes.setQueue(UC4ObjectName queue)	Sets the Queue that will be used when this Automation Engine object is executed.
void	ScriptAttributes.setQueue(UC4ObjectName queue)	Sets the Queue that will be used when this object is executed.
void	CurrentQueueCondition.setQueueName(UC4ObjectName queueName)
void	Runtime.setRetCodeExecuteObject(UC4ObjectName retCodeExecuteObject)	Sets the name of the Automation Engine Object which should be executed when the actual return code is higher than the maximum allowed return code.
void	Rollback.setRollbackObject(UC4ObjectName rollbackObject)	Sets the rollback object.
void	SAPAgentPanel.setSdlConnection(UC4ObjectName sdlConnection)
void	FileTransferSettings.setSourceCodeTable(UC4ObjectName sourceCodeTable)	Sets the CodeTable for all source files.
void	FileTransferSettings.setSourceLogin(UC4ObjectName sourceLogin)	Sets the name fo the Login Object which should be used by source Agent.
void	DatabaseEventValue.setSourceQuery(String sqlStatement, UC4HostName agentName, UC4ObjectName loginObject, String server, String database, String accessFile)	Sets the Source of this DatabaseEventValue to an SQL Query.
void	DatabaseEventValue.setSourceVariable(UC4ObjectName variableName, UC4ObjectName variableKeyword)	Deprecated. : variableKeyowrd type changed from UC4ObjectName to String.
void	DatabaseEventValue.setSourceVariable(UC4ObjectName variableName, String variableKeyword)	Sets the Source of this DatabaseEventValue to the content of a variable.
void	EventAttributes.setStartType(UC4ObjectName startType)	Sets the start type of this Job.
void	FileTransferAttributes.setStartType(UC4ObjectName startType)	Sets the start type of this Job.
void	JobAttributes.setStartType(UC4ObjectName startType)	Sets the start type of this Job.
void	JobPlanAttributes.setStartType(UC4ObjectName startType)	Sets the start type of this JobPlan.
void	NotificationAttributes.setStartType(UC4ObjectName startType)	Sets the start type of this Notification.
void	ScheduleAttributes.setStartType(UC4ObjectName startType)	Sets the start type of this job.
void	ScriptAttributes.setStartType(UC4ObjectName startType)	Sets the start type of this Script.
void	RuleEventSetting.setStoreName(UC4ObjectName storeName)	Sets the Store object which this Event is linked to.
void	CockpitControlDataSource.setVariable(UC4ObjectName variable)	Sets the data source variable.
void	CompositeVariable.setVariable1(UC4ObjectName variable1)	Sets the name of the first variable.
void	CompositeVariable.setVariable2(UC4ObjectName variable2)	Sets the name of the first variable.
void	ClearVariableAction.setVariableName(UC4ObjectName variableName)	Sets the name of the Variable object.
void	SetVariableAction.setVariableName(UC4ObjectName variableName)
void	SAPAgentPanel.setXiConnection(UC4ObjectName xiConnection)

Constructors in com.uc4.api.objects with parameters of type UC4ObjectName

Modifier	Constructor	Description
	CalendarCondition(UC4ObjectName name, UC4ObjectName keyword)	Deprecated. potentially dangerous as a keyword does not adhere to uc4objectName standards and skip_name_check is implicitly expected
	CalendarCondition(UC4ObjectName name, String keyword)	Constructs a new CalendarCondition using the specified calendar name and keyword.
	ExecuteRecurring(UC4ObjectName uc4ObjectNamme)	Constructs a new ExecuteRecurring instance by also providing the uc4 object name of the recurring object with the default setting to execute the task every 30 minutes on each weekday.
	GroupCalendarKeyword(UC4ObjectName name)	Constructs a new GroupCalendarKeyword.
	MonthlyCalendarKeyword(UC4ObjectName name)	Constructs a new MonthlyCalendarKeyword.
	MonthlyCalendarKeyword(UC4ObjectName name, int nMonth, int startMonth, int endMonth)	Constructs a new MonthlyCalendarKeyword.
	OutputScanFilter(UC4ObjectName filterName, boolean condition, int returnCode, UC4ObjectName executeObject)	Creates a new instance of this class.
	OutputScanFilter(UC4ObjectName filterName, boolean condition, int returnCode, UC4ObjectName executeObject, String statusText)	Creates a new instance of this class.
	RollCalendarKeyword(UC4ObjectName name, CalendarCondition cond)	Constructs a new RollCalendarKeyword using the specified source calendar condition.
	StaticCalendarKeyword(UC4ObjectName name, DateTime from, DateTime to)	Constructs a new StaticCalendarKeyword using the specified name and date range.
	SyncItem(UC4ObjectName syncObject, String startAction, String endAction, String abendAction, String elseAction)	Constructs a SyncEntry using the specified parameters.
	WeeklyCalendarKeyword(UC4ObjectName name)	Constructs a new WeeklyCalendarKeyword.
	WeeklyCalendarKeyword(UC4ObjectName name, int nWeek, int startWeek, int endWeek)	Constructs a new WeeklyCalendarKeyword.
	YearlyCalendarKeyword(UC4ObjectName name)	Constructs a new YearlyCalendarKeyword.
	YearlyCalendarKeyword(UC4ObjectName name, int nYear, int startWithYear)	Constructs a new YearlyCalendarKeyword.

Uses of UC4ObjectName in com.uc4.api.prompt

Methods in com.uc4.api.prompt that return UC4ObjectName

Modifier and Type	Method	Description
UC4ObjectName	CheckGroupElement.getDataReference()
UC4ObjectName	ComboElement.getDataReference()
UC4ObjectName	DateElement.getDataReference()
UC4ObjectName	NumberElement.getDataReference()
UC4ObjectName	PromptInterfaces.DataReference.getDataReference()
UC4ObjectName	RadioGroupElement.getDataReference()
UC4ObjectName	TextElement.getDataReference()
UC4ObjectName	TimeElement.getDataReference()

Methods in com.uc4.api.prompt with parameters of type UC4ObjectName

Modifier and Type	Method	Description
void	CheckGroupElement.setDataReference(UC4ObjectName vara)	Sets a VARA Object which contains a list of valid entries for this prompt element.
void	ComboElement.setDataReference(UC4ObjectName vara)	Sets a VARA Object which contains a list of valid entries for this prompt element.
void	DateElement.setDataReference(UC4ObjectName vara)	Sets a VARA Object which contains a list of valid entries for this prompt element.
void	NumberElement.setDataReference(UC4ObjectName vara)	Sets a UC4 VARA Object which contains a list of valid entries for this prompt element.
void	PromptInterfaces.DataReference.setDataReference(UC4ObjectName vara)	Sets a VARA Object which contains a list of valid entries for this prompt element.
void	RadioGroupElement.setDataReference(UC4ObjectName vara)	Sets a VARA Object which contains a list of valid entries for this prompt element.
void	TextElement.setDataReference(UC4ObjectName vara)	Sets a UC4 VARA Object which contains a list of valid entries for this prompt element.
void	TimeElement.setDataReference(UC4ObjectName vara)	Sets a VARA Object which contains a list of valid entries for this prompt element.

Constructors in com.uc4.api.prompt with parameters of type UC4ObjectName

Modifier	Constructor	Description
	CheckGroupElement(String variableName, UC4ObjectName reference)	Creates a new CheckGroupElement.
	CheckListElement(String variableName, UC4ObjectName reference)	Creates a new CheckListElement.
	ComboElement(String variableName, UC4ObjectName reference)
	DateElement(String variableName, UC4ObjectName reference)	Creates a new DateElement.
	NumberElement(String variableName, UC4ObjectName reference)	Creates a new number field.
	RadioGroupElement(String variableName, UC4ObjectName reference)	Creates a new RadioGroupElement.
	TextElement(String variableName, UC4ObjectName reference)
	TimeElement(String variableName, UC4ObjectName reference)	Creates a new TimeElement.
	TimeStampElement(String variableName, UC4ObjectName reference)

Uses of UC4ObjectName in com.uc4.api.systemoverview

Methods in com.uc4.api.systemoverview that return UC4ObjectName

Modifier and Type	Method	Description
UC4ObjectName	AgentAssignmentListItem.getName()	Returns the name of the Agent assignment.
UC4ObjectName	AgentGroupListItem.getName()	Returns the name of the host group.
UC4ObjectName	CheckILMPartitionItem.getName()	Returns the name of the object.

Uses of UC4ObjectName in com.uc4.communication

Methods in com.uc4.communication that return UC4ObjectName

Modifier and Type	Method	Description
UC4ObjectName	ERPFormsSettings.getDefaultLogin()	Returns the Login object that should be used by default in the "Form" tab of PeopleSoft jobs in order to connect to the Enterprise Business Solution.
UC4ObjectName	ProcessFlowSettings.getElseExecute()	Returns the default name of the UC4 Object which should be executed as ELSE action when a task are added to a Process Flow.
UC4ObjectName	MessageSettings.getGroup()	Returns the name of the user group if own messages are selected (EverythingInClient is set to false).
UC4ObjectName	ActivationProtocol.getName()

Methods in com.uc4.communication with parameters of type UC4ObjectName

Modifier and Type	Method	Description
void	DefaultNotificationListener.activationMessages(int runNumner, UC4ObjectName task, TranslatedMessage[] messages)
void	INotificationListener.activationMessages(int runNumner, UC4ObjectName task, TranslatedMessage[] messages)	This method is called if there is an activation protocol for a task.
void	ERPFormsSettings.setDefaultLogin(UC4ObjectName defaultLogin)	Sets the Login object that should be used by default in the "Form" tab of PeopleSoft jobs in order to connect to the Enterprise Business Solution.
void	ProcessFlowSettings.setElseExecute(UC4ObjectName elseExecute)	Sets the default name of the UC4 Object which should be executed as ELSE action when a task are added to a Process Flow.
void	MessageSettings.setGroup(UC4ObjectName group)	Sets the name of the user group if own messages are selected (EverythingInClient is set to false).

Uses of UC4ObjectName in com.uc4.communication.requests

Methods in com.uc4.communication.requests that return UC4ObjectName

Modifier and Type	Method	Description
UC4ObjectName	GetAgentGroupProperties.getAgentGroupName()	Returns the agents name
UC4ObjectName	GetAgentProperties.getAgentName()	Returns the agents name
UC4ObjectName	GetCPProperties.getCPName()	Returns the CP name.
UC4ObjectName	JobPlanMonitor.Task.getExternalParent()	Returns the name of the external parent or an empty UC4ObjectName.
UC4ObjectName	ActiveNotifications.Entry.getName()	Returns the name of the Notification object.
UC4ObjectName	CheckAuthorizations.Candidate.getName()	Returns the name of the Object.
UC4ObjectName	CreateObject.getName()	Returns the name of the object.
UC4ObjectName	GetDeployObjectProperties.getName()	Returns the name of the UC4 JOBP Object.
UC4ObjectName	GetObjectProperties.getName()	Returns the name of the Object.
UC4ObjectName	GetChangeLog.Entry.getObjectName()	Returns the name of the object.
UC4ObjectName	GetReplaceList.getObjName()	Returns the name of the AE Object.
UC4ObjectName	TaskPromptSetContent.getPromptSetName()	Returns the name of the PromptSet.
UC4ObjectName[]	TaskPromptSetNames.getPromptSets()	Deprecated. Use the iterator() method instead.
UC4ObjectName	GetExecuteOnce.getQueue()	Returns the name of the queue object where the task runs.
UC4ObjectName	GetWPProperties.getWPName()	Returns the WP name.

Methods in com.uc4.communication.requests that return types with arguments of type UC4ObjectName

Modifier and Type	Method	Description
Iterator<UC4ObjectName>	FindReferencedObjects.iterator()
Iterator<UC4ObjectName>	GetRAConnectionNames.iterator()
Iterator<UC4ObjectName>	GetSyncUsage.iterator()

Methods in com.uc4.communication.requests with parameters of type UC4ObjectName

Modifier and Type	Method	Description
protected static final void	XMLRequest.checkUC4ObjectEmptyName(UC4ObjectName name)
protected static final void	XMLRequest.checkUC4ObjectName(UC4ObjectName name)
void	ExecuteObject.executeOnce(DateTime startDate, DateTime logicalDate, UC4TimezoneName tz, boolean waitForManualRelease, ExecuteTestOptions options, UC4ObjectName queue)	Executes a task only once.
void	ExecuteObject.executeOnce(DateTime startDate, DateTime logicalDate, UC4TimezoneName tz, boolean waitForManualRelease, ExecuteTestOptions options, UC4ObjectName queue, UC4Alias aliasName)	Executes a task only once.

Constructors in com.uc4.communication.requests with parameters of type UC4ObjectName

Modifier	Constructor	Description
	ActivateObject(UC4ObjectName name)	Toggles the active state of the given object.
	AddJobPlanTask(UC4ObjectName objectName)	Constructs a AddJobPlanTask using the specified UC4 Object name.
	AddJobPlanTask(UC4ObjectName objectName, UC4Alias alias)	Constructs a AddJobPlanTask using the specified UC4 Object name and alias.
	AddPromptSet(UC4ObjectName promptSetName)	Deprecated. Use constructor with passed UC4Object
	AddPromptSet(UC4ObjectName promptSetName, UC4Object obj)	Constructs a new AddPromptSet request using the specified PromptSet name.
	AddScheduleMonitorTask(UC4ObjectName name, int parentIdnr)	Constructs a AddScheduleMonitorTask request using the specified name and add it to the parent task of given parentIdnr.
	AddScheduleTask(UC4ObjectName name)	Constructs a AddScheduleTask request using the specified name.
	AgentGroupSimulation(UC4ObjectName agentGroup)	Creates a new AgentGroupSimulation request.
	Candidate(UC4ObjectName obj, char access)	Creates a new Candidate instance.
	Candidate(UC4ObjectName obj, UserRight.Type objectType, char access)	Creates a new Candidate instance.
	CreateObject(UC4ObjectName name, Template template, IFolder folder)	Creates an UC4 Object.
	DeleteObject(UC4ObjectName objectName)	Deletes the specified object.
	DeleteObject(UC4ObjectName[] names)	Deletes UC4 Objects with the specified names.
	DeleteObject(UC4ObjectName[] names, IFolder[] folders)	This constructor is used to delete multiple FOLD and UC4Object objects in AE.
	DeleteObject(UC4ObjectName objectName, IFolder folder)	Constructs a DeleteObject using the specified UC4 object name.
	DeleteStaticVaraRow(UC4ObjectName objectName, String... keys)	Creates a new instance of the DeleteStaticVaraRow request.
	DisconnectAgentGroup(UC4ObjectName agentGroup)	Creates a new request to disconnect all Agents in an AgentGroup.
	DownloadBinary(UC4ObjectName storeObject, String entryName, PlatformSwHwType platformSwHw)	Creates a new request to download a file from a STORE object.
	DownloadBinary(UC4ObjectName storeObject, String entryName, PlatformSwHwType platformSwHw, File outputFile)	Creates a new request to download a file from a STORE object.
	DownloadBinary(UC4ObjectName storeObject, String entryName, PlatformSwHwType platformSwHw, File outputFile, String resname)	Creates a new request to download a file from a STORE object.
	DownloadBinary(UC4ObjectName storeObject, String entryName, PlatformSwHwType platformSwHw, String resname)	Creates a new request to download a file from STORE object.
	DuplicateObject(UC4Object object, UC4ObjectName newName, IFolder folder)	Creates a new DuplicateObject request.
	DuplicateObject(UC4ObjectName name, UC4ObjectName newName, IFolder folder)	Creates a new DuplicateObject request.
	DuplicateObject(UC4ObjectName name, UC4ObjectName newName, IFolder folder, String title)	Creates a new DuplicateObject request.
	ExecuteAgentAssignment(UC4ObjectName name)	Creates new ExecuteAgentAssignment request.
	ExecuteObject(UC4ObjectName name)	Constructs a ExecuteObject using the specified object name.
	ExportObject(UC4ObjectName[] names, File export)	Exports a list of UC4 Objects.
	ExportObject(UC4ObjectName[] names, List<IFolder> folders, File export, boolean exportLinks)	Export given folder list and objects
	ExportObject(UC4ObjectName name, File export)	Exports a single Object.
	ExportWithReferences(UC4ObjectName name, File exportFile)	Creates a new request to export an object with all referenced objects.
	FindReferencedObjects(UC4ObjectName object)	Creates a request to get a list of object names in an executable object.
	GetAgentGroupProperties(UC4ObjectName agentName)	Creates a new instance of the GetAgentGroupProperties request.
	GetAgentProperties(UC4ObjectName agentName)	Creates a new instance of the GetAgentProperties request.
	GetCPProperties(UC4ObjectName cpName)	Creates an instance of GetWPProperties
	GetDynamicComboList(String variableName, UC4ObjectName promptSet, int runID, TaskPromptSetContent... content)	Creates a new GetDynamicComboList request in order to get the list of values of a dynamic ComboElement in a prompt.
	GetDynamicComboList(String variableName, UC4ObjectName promptSet, ITaskItem task, TaskPromptSetContent... content)	Creates a new GetDynamicComboList request in order to get the list of values of a dynamic ComboElement in a prompt.
	GetDynamicComboList(String variableName, UC4ObjectName promptSet, UC4Object object, TaskPromptSetContent... content)	Creates a new GetDynamicComboList request in order to get the list of values of a dynamic ComboElement in a prompt.
	GetExecuteOnce(UC4ObjectName name)	Reads the default settings for a task that will be scheduled.
	GetExecutePeriod(UC4ObjectName objectname)	Constructs a new GetExecutePeriod request.
	GetLastRuntimes(UC4ObjectName name)	Creates a new request to get the last 25 RRTs and ERTs.
	GetObjectDocu(UC4ObjectName name)
	GetObjectProperties(UC4ObjectName name)	Creates a new Request to get information about an UC4 object.
	GetRAConnectionValues(UC4ObjectName conName)	Creates a new GetRAConnectionValues request.
	GetReplaceList(UC4ObjectName obj)	Creates a new GetReplaceList request to replace the specified object.
	GetRestartInformation(UC4ObjectName uc4ObjectName)	Creates a new GetRestartInformation request.
	GetStaticVaraRows(UC4ObjectName objectName, String... keys)	Creates a new instance of the GetStaticVaraRows request.
	GetStorageItems(UC4ObjectName name)	Construct this object and set requested storage name.
	GetSyncMonitor(UC4ObjectName name)	Creates a new GetSyncMonitor.
	GetWPProperties(UC4ObjectName wpName)	Creates an instance of GetWPProperties
	LatestReport(UC4ObjectName name)	Constructs a LastestReport using the specified name of an UC4 Object.
	ModifyQueueStatus(UC4ObjectName name, QueueStatus status)	Creates a new instance of a SwitchQueueStatus class.
	ObjectStatistics(UC4ObjectName name)	Creates a request instance to read the statistic of the specified object.
	ObjectStatistics(UC4ObjectName name, int maxResult)	Creates a request instance to read the statistic of the specified object.
	OpenObject(UC4ObjectName name)	Constructs a OpenObject using the specified UC4 Object name.
	OpenObject(UC4ObjectName name, boolean readOnly, boolean fullObject)	Constructs a OpenObject using the specified UC4 Object name.
	PreviewVariable(UC4ObjectName name)	Creates a new Preview Request for dynamic Variables.
	PromptInputHelp(String variableName, UC4ObjectName promptSet, int runID, String filterText, int filterColumn, TaskPromptSetNames names, TaskPromptSetContent... content)	Creates an input help based on values entered in prompts.
	PromptInputHelp(String variableName, UC4ObjectName promptSet, String filter, int filterColumn)	Deprecated. Use PromptInputHelp(String variableName, UC4ObjectName promptSet, String filter, int filterColumn, UC4Object object) instead
	PromptInputHelp(String variableName, UC4ObjectName promptSet, String filter, int filterColumn, ITaskItem task)	Input help of Prompt values for objects.
	PromptInputHelp(String variableName, UC4ObjectName promptSet, String filter, int filterColumn, UC4Object object)	Input help of Prompt values for objects.
	ReleaseQuarantineMessage(int message, UC4ObjectName activeServerName, int[] traceFlags)	Creates a new ReleaseQuarantineMessage request.
	RenameObject(IFolder oldName, UC4ObjectName newName)	This constructor is used to rename folders.
	RenameObject(IFolder oldName, UC4ObjectName newName, String title)	This constructor is used to rename folders.
	RenameObject(UC4ObjectName oldName, UC4ObjectName newName, IFolder folder)	Deprecated. Use RenameObject(UC4ObjectName oldName, UC4ObjectName newName, IFolder folder, String title) instead
	RenameObject(UC4ObjectName oldName, UC4ObjectName newName, IFolder folder, String title)	Constructs a RenameObject.
	ReplaceObject(UC4ObjectName oldName, String type, UC4ObjectName newName, SearchResultItem... results)	Replaces an UC4 Object based on a search result.
	ReplaceObject(GetReplaceList list, UC4ObjectName name, int replaceMax)	Replaces an UC4 Object.
	ResetLastRuntimes(UC4ObjectName name)	Creates a new request to get the last 25 RRTs and ERTs.
	ResetOpenFlag(UC4ObjectName name)	Constructs a new ResetOpenFlag request which is used to reset the open flag.
	RestartTask(int runID, UC4ObjectName queue)	Creates a new RestartTask request to restart the task with the specified RunID.
	RestartTask(UC4ObjectName name, UC4ObjectName queue)	Restarts a task from the object definition.
	SetObjectProperties(UC4ObjectName name)	Creates a new Request to set ObjectAuthorizations for an UC4 object.
	SetStaticVaraRows(UC4ObjectName objectName)	Creates a new instance of the SetStaticVaraRows request.
	SetSyncMonitor(UC4ObjectName name, String state, int value)	Modifies the Sync Monitor.
	TaskPromptSetContent(UC4ObjectName promptSetName, int runID)	Deprecated. Use the constructor TaskPromptSetContent(TaskPromptSetName promptSetName, int runID) instead.
	TaskPromptSetContent(UC4ObjectName promptSetName, ITaskItem task)	Creates a request to get the content of a PromptSet of a JOBP task.
	UntransportObject(UC4ObjectName obj)	Creates a request to remove an object from transport case.
	UploadBinary(UC4ObjectName storeObject, String entryName, PlatformSwHwType osPlatformHw, boolean isUpdate, File inputFile)	Creates a new request to upload a file to a STORE object.
	UploadBinary(UC4ObjectName storeObject, String entryName, PlatformSwHwType osPlatformHw, boolean isUpdate, ByteBuffer buffer)	Creates a new request to upload a file to a STORE object.
	VersionControlList(UC4ObjectName name)	Creates a new instance of VersionControlList.

Constructor parameters in com.uc4.communication.requests with type arguments of type UC4ObjectName

Modifier	Constructor	Description
	ActivateObject(List<UC4ObjectName> names)	Toggles the active state of the given objects.
	DisconnectAgentGroup(List<UC4ObjectName> agentGroups)	Creates a new request to disconnect all Agents in AgentGroups.
	ExecuteObjects(List<UC4ObjectName> uC4ObjectNames)	Constructs a ExecuteObjects using the specified object name list.