public interface ICore
Modifier and Type | Method and Description |
---|---|
FormStatus |
cancelItemProcess(int itemId,
java.lang.String actionName)
This operation cancels the process with the specified name for the Item
identified.
|
java.lang.String |
connect()
This operation "connects" a client to the ICore.
|
java.lang.String |
createItem(java.lang.String itemType)
This operation directs ICE to create a new Item.
|
void |
deleteItem(java.lang.String itemId)
This operation directs the ICore to permanently delete an Item.
|
void |
disconnect(int uniqueClientId)
This operation will disconnect a client from the remote server if it is
connected.
|
ICEList<java.lang.String> |
getAvailableItemTypes()
This operation returns a list of the available Item types that can be
created by ICE or null if no Items are registered with the Core.
|
Form |
getFileSystem(int uniqueClientID)
This operation retrieves the workspace file system available to the
ICEUser.
|
Form |
getItem(int itemId)
This operation returns the representational state, a Form, of an Item
that is managed by the ICore to the caller.
|
java.util.ArrayList<Identifiable> |
getItemList()
This operation returns the list of Items that have been created in ICE.
|
java.io.File |
getItemOutputFile(int id)
This operation returns a file handle to the output file for the Item with
the specified id.
|
FormStatus |
getItemStatus(java.lang.Integer id)
This operation returns the status an Item.
|
void |
importFile(java.net.URI file)
This operation directs the core to import a file into its workspace.
|
java.lang.String |
importFileAsItem(java.net.URI file,
java.lang.String itemType)
This operation directs the core to import a file into its workspace and
load that file as an input for the specified Item type.
|
java.lang.String |
postUpdateMessage(java.lang.String message)
This operation posts a message containing an update to the ICE Item
designated in the body of the message.
|
FormStatus |
processItem(int itemId,
java.lang.String actionName,
int uniqueClientId)
This operation directs the Core to process the Item with the specified id
by performing the specific action.
|
void |
registerCompositeItem(ICompositeItemBuilder builder)
This operation registers a composite Item with the ICore.
|
void |
registerItem(ItemBuilder itemBuilder)
This operation registers an ItemBuilder and thereby a particular Item
class with the Core.
|
void |
unregisterItem(ItemBuilder itemBuilder)
This operation unregisters an ItemBuilder and thereby a particular Item
class with the Core.
|
FormStatus |
updateItem(Form form,
int uniqueClientId)
This operation posts an updated Form to the Core so that the updated
information can be processed by the appropriate Item.
|
java.lang.String connect()
void disconnect(int uniqueClientId)
uniqueClientId
- The unique client identification number of the client that
would like to disconnect.Form getFileSystem(int uniqueClientID)
uniqueClientID
- The unique ID of the Client calling the operation.void registerItem(ItemBuilder itemBuilder)
itemBuilder
- An instance of ItemBuilder for a particular Item that is
available to the Core.void registerCompositeItem(ICompositeItemBuilder builder)
builder
- The ICompositeItemBuilder that will build the composite Item.void unregisterItem(ItemBuilder itemBuilder)
itemBuilder
- An instance of ItemBuilder for a particular Item that is now
unavailable to the Core.java.lang.String createItem(java.lang.String itemType)
itemType
- The type of Item to create.void deleteItem(java.lang.String itemId)
itemId
- The identification number of the Item that should be deleted
given as a String. It is safe to parse this string as an
integer.FormStatus getItemStatus(java.lang.Integer id)
id
- The identification number of the Item that should be checked.Form getItem(int itemId)
itemId
- The identification number of the Item that should be
retrieved.ICEList<java.lang.String> getAvailableItemTypes()
FormStatus updateItem(Form form, int uniqueClientId)
form
- The Form that carries new information for an Item.uniqueClientId
- The unique client id the IClient that is making the update
request.FormStatus processItem(int itemId, java.lang.String actionName, int uniqueClientId)
itemId
- The item id for the Item that should be processed with the
specified action.actionName
- The action that should be performed on the Item.uniqueClientId
- The unique identification number of the client making the
request.java.util.ArrayList<Identifiable> getItemList()
java.io.File getItemOutputFile(int id)
id
- The id of the Item.FormStatus cancelItemProcess(int itemId, java.lang.String actionName)
itemId
- The id of the Item whose process should be canceled.actionName
- The name of the action that should be canceled for the
specified Item.void importFile(java.net.URI file)
file
- The file that should be imported. Nothing will happen if this
argument is null.java.lang.String importFileAsItem(java.net.URI file, java.lang.String itemType)
file
- The file that should be imported. Nothing will happen if this
argument is null.itemType
- The type of Item to create.java.lang.String postUpdateMessage(java.lang.String message)
message
- The message that should be passed on to the specified Item.
This string must be in JSON and conform to the message format
of the ICE Updater.