Package com.uc4.api

This package contains classes which are generally used.

See: Description

Interface Summary

Interface	Description
HasAlias	Interface that indicates the availability of an alias.
IFormItem	This interface is implemented by all item in a read form.
ITransportable	Classes that provide transportable Automation Engine Objects must implement this interface.
ITreeItem	This interface is implemented by all item of a navigator tree.

Class Summary

Class	Description
AbstractFormItem	Shared implementation for each concrecte form item.
AbstractTask	This is the base class of tasks (active or archived).
AutoForecastItem	This class represents a single row in the result of an Autoforecast.
ComponentWorkflowObjectName	This class represents a template information of a component workflow.
DateTime	This class represents a local date and time.
DetailGroup	This class represents a Group in the Detail of a task.
ExecuteTestOptions	Various test options are available in order to execute objects with options.
FolderListItem	This class represents one object in a folder.
ForecastItem	This class represents a single row in the Forecast list.
ForecastTreeItem	This class represents a single row in the tree view of the forecast.
Form	Form for interactive user input.
FormItemLabel	This class represents a label in a Form.
FormItemList	This class is used for fields which contain a list of predefined values.
FormItemNumber	This class is used for fields which can only contain numbers.
FormItemText	This class is used for text input fields and date fields.
MessageBox	This class a represents a message box.
ObjectTypeFilter	This is a abstract base class for filters which needs object types.
QuickSearchItem	This class represents a line the quick access list.
SearchResultItem	This class represents an item from the search result.
ServiceLevelObjectiveListItem	This class represents one item of a service level objective list.
StatisticSearchItem	This class represents a row in the result of a statistics search.
StorageItem	This class represents one resource in storage object.
Task	This class contains a description of a single task in the ActivityList.
TaskFilter	This class represents a filter for the activity list.
TaskPromptSetName	This class contains information about a single prompt set.
Template	This class describes a single object template.
Time	This class represents a Time which consits of hours and minutes only.
TraceOptions	Base class for Trace Options (can be used by Agent and Server to set/get trace options)
TraceOptions.TraceFlag	Class used to represent a AE trace flag.
TrafficLight	This class represents the traffic light information.
TranslatedMessage	This class represents a translated message.
UC4Alias	This class stores a valid alias.
UC4HostName	This class represents name of an Agent.
UC4ObjectName	This class represents the name of an object in the Automation Engine.
UC4TimezoneName	This class represents the name of a TimeZone object.
UC4UserName	This class represents the name of a USER object.
VersionControlListItem	This class represents a saved version of an Automation Engine object.

Enum Summary

Enum	Description
AgentStatus	Status of an Agent.
PlatformSwHwType	Combined type of Platform, SW, HW of the file.
QueueStatus	Status of a Queue object.
StorageItem.UsageType	Represents usage type of the resource.
TaskFilter.TimeFrame	TimeFrame for the activation filter.
TaskFilter.TimeUnit	Time Unit for the Activation filter.
TraceOptions.TraceType	Enumeration for Trace types

Exception Summary

Exception	Description
InvalidUC4NameException	This runtime exception is thrown if the name of an object is invalid.

Package com.uc4.api Description

This package contains classes which are generally used.