org.cmis.interopserver.services.tie
Interface Tie

All Superinterfaces:

org.cmis.interopserver.services.base.Base, java.rmi.Remote

All Known Implementing Classes:

TieSoapBindingImpl, TieSoapBindingSkeleton, TieSoapBindingStub

public interface Tie
extends java.rmi.Remote, org.cmis.interopserver.services.base.Base

This is the main Tie service interface for DMIS interoperability

Author:

Interop team

Method Summary

org.cmis.interopserver.beans.TieIncident[]	getAllIncidents(boolean showVersions) Fetches a list of all versions of incidents posted to this COG and saved by this COG suitable for displaying in a list
org.cmis.interopserver.beans.AttachmentDescriptor[]	getAttachmentList(java.lang.String vendorIncidentId) This method takes an incident ID and version number and returns an array of AttachmentDescriptors for the given incident
org.cmis.interopserver.beans.AttachmentDescriptor[]	getAttachmentList(java.lang.String vendorIncidentId, long version) This method takes an incident ID and returns an array of AttachmentDescriptors for the given incident
void	getAttachments(java.lang.String vendorIncidentId, org.cmis.interopserver.beans.AttachmentDescriptor[] attachments, boolean getInDIMEFormat) This method takes an incident ID, an array of file names and a boolean to specify whether attachments should be retrieved in DIME format or in conformance with the SOAP with Attachments specification (MIME).
void	getAttachments(java.lang.String vendorIncidentId, long version, org.cmis.interopserver.beans.AttachmentDescriptor[] attachments, boolean getInDIMEFormat) This method takes an incident ID, a version number, an array of file names and a boolean to specify whether attachments should be retrieved in DIME format or in conformance with the SOAP with Attachments specification (MIME).
org.cmis.interopserver.beans.SimpleCOG[]	getCOGsPostedTo(java.lang.String vendorIncidentId) Gets the list of COGs that a particular incident was posted to in the latest version
org.cmis.interopserver.beans.SimpleCOG[]	getCOGsPostedTo(java.lang.String vendorIncidentId, long version) Gets the list of SimpleCOGs that a particular incident version was posted to
org.cmis.interopserver.beans.TieIncident	getIncident(java.lang.String vendorIncidentId) This method takes an incident ID and returns detailed incident information returned in the form of a TieIncident object.
org.cmis.interopserver.beans.TieIncident	getIncident(java.lang.String vendorIncidentId, long version) This method takes an incident ID and version number and returns detailed incident information returned in the form of a TieIncident object.
org.cmis.interopserver.beans.TieIncident[]	getIncidentHistory(java.lang.String vendorIncidentId) This method takes an incident ID and version and returns detailed incident information returned in the form of a TieIncident object.
java.lang.String[]	getValidCategoryNames() Fetches a list of valid category names
java.lang.String[]	getValidConfidenceNames() Fetches a list of valid confidence names
java.lang.String[]	getValidNotificationLevelNames() Fetches a list of valid notification level names
java.lang.String[]	getValidPhaseNames() Fetches a list of valid phase names
java.lang.String[]	getValidSeverityNames() Fetches a list of valid severity names
java.lang.String[]	getValidStatusNames() Fetches a list of valid status names
java.lang.String[]	getValidTypeNames() Fetches a list of valid type names
java.lang.String	postIncident(org.cmis.interopserver.beans.TieIncident info, org.cmis.interopserver.beans.SimpleCOG[] postToCogs, org.cmis.interopserver.beans.AttachmentDescriptor[] attachments) This method takes three arguments: an instance of TieIncident, an array of SimpleCOGs and an array of AttachmentDescriptors.

Methods inherited from interface org.cmis.interopserver.services.base.Base

getCogs, getMyCog, ping

Method Detail

getAllIncidents

org.cmis.interopserver.beans.TieIncident[] getAllIncidents(boolean showVersions)
                                                           throws java.rmi.RemoteException

Fetches a list of all versions of incidents posted to this COG and saved by this COG suitable for displaying in a list

Parameters:

showVersions - if set to true will return all versions of all incidents, if false this method returns a list of the latest version of all incidents

Returns:

a list of all versions of incidents posted to this COG and saved by this COG

Throws:

java.rmi.RemoteException - An exception occurred remotely

getAttachmentList

org.cmis.interopserver.beans.AttachmentDescriptor[] getAttachmentList(java.lang.String vendorIncidentId,
                                                                      long version)
                                                                      throws java.rmi.RemoteException

This method takes an incident ID and returns an array of AttachmentDescriptors for the given incident

Parameters:

vendorIncidentId - ID used to reference an incident

version - Used to retrieve a particular version

Returns:

An array of AttachmentDescriptors

Throws:

java.rmi.RemoteException - An exception occurred remotely

getAttachmentList

org.cmis.interopserver.beans.AttachmentDescriptor[] getAttachmentList(java.lang.String vendorIncidentId)
                                                                      throws java.rmi.RemoteException

This method takes an incident ID and version number and returns an array of AttachmentDescriptors for the given incident

Parameters:

vendorIncidentId - used to reference an incident

Returns:

An array of AttachmentDescriptors

Throws:

java.rmi.RemoteException - An exception occurred remotely

getAttachments

void getAttachments(java.lang.String vendorIncidentId,
                    long version,
                    org.cmis.interopserver.beans.AttachmentDescriptor[] attachments,
                    boolean getInDIMEFormat)
                    throws java.rmi.RemoteException

This method takes an incident ID, a version number, an array of file names and a boolean to specify whether attachments should be retrieved in DIME format or in conformance with the SOAP with Attachments specification (MIME).

Parameters:

vendorIncidentId - used to reference an incident

version - used to retrieve a particular version

attachments - An array of AttachmentDescriptors

getInDIMEFormat - set to true if attachments should be retrieved in DIME format

Throws:

java.rmi.RemoteException - An exception occurred remotely

getAttachments

void getAttachments(java.lang.String vendorIncidentId,
                    org.cmis.interopserver.beans.AttachmentDescriptor[] attachments,
                    boolean getInDIMEFormat)
                    throws java.rmi.RemoteException

This method takes an incident ID, an array of file names and a boolean to specify whether attachments should be retrieved in DIME format or in conformance with the SOAP with Attachments specification (MIME).

Parameters:

vendorIncidentId - used to reference an incident

attachments - An array of AttachmentDescriptors

getInDIMEFormat - set to true if attachments should be retrieved in DIME format

Throws:

java.rmi.RemoteException - An exception occurred remotely

getCOGsPostedTo

org.cmis.interopserver.beans.SimpleCOG[] getCOGsPostedTo(java.lang.String vendorIncidentId,
                                                         long version)
                                                         throws java.rmi.RemoteException

Gets the list of SimpleCOGs that a particular incident version was posted to

Parameters:

vendorIncidentId - used to reference an incident

version - used to retrieve a particular version

Returns:

Gets the list of SimpleCOGs that a particular incident version was posted to

Throws:

java.rmi.RemoteException - An exception occurred remotely

getCOGsPostedTo

org.cmis.interopserver.beans.SimpleCOG[] getCOGsPostedTo(java.lang.String vendorIncidentId)
                                                         throws java.rmi.RemoteException

Gets the list of COGs that a particular incident was posted to in the latest version

Parameters:

vendorIncidentId - used to reference an incident

Returns:

Gets the list of SimpleCOGs that a particular incident version was posted to

Throws:

java.rmi.RemoteException - An exception occurred remotely

getIncident

org.cmis.interopserver.beans.TieIncident getIncident(java.lang.String vendorIncidentId,
                                                     long version)
                                                     throws java.rmi.RemoteException

This method takes an incident ID and version number and returns detailed incident information returned in the form of a TieIncident object.

Parameters:

vendorIncidentId - ID used to reference an incident

version - used to retrieve a particular version

Returns:

TieIncident Object

Throws:

java.rmi.RemoteException - An exception occurred remotely

getIncident

org.cmis.interopserver.beans.TieIncident getIncident(java.lang.String vendorIncidentId)
                                                     throws java.rmi.RemoteException

This method takes an incident ID and returns detailed incident information returned in the form of a TieIncident object.

Parameters:

vendorIncidentId - used to reference an incident

Returns:

detailed incident information returned in the form of a TieIncident object

Throws:

java.rmi.RemoteException - An exception occurred remotely

getIncidentHistory

org.cmis.interopserver.beans.TieIncident[] getIncidentHistory(java.lang.String vendorIncidentId)
                                                              throws java.rmi.RemoteException

This method takes an incident ID and version and returns detailed incident information returned in the form of a TieIncident object.

Parameters:

vendorIncidentId - used to reference an incident

Returns:

detailed incident information returned in the form of a TieIncident object

Throws:

java.rmi.RemoteException - An exception occurred remotely

getValidCategoryNames

java.lang.String[] getValidCategoryNames()
                                         throws java.rmi.RemoteException

Fetches a list of valid category names

Returns:

an array of valid category names

Throws:

java.rmi.RemoteException - An exception occurred remotely

getValidConfidenceNames

java.lang.String[] getValidConfidenceNames()
                                           throws java.rmi.RemoteException

Fetches a list of valid confidence names

Returns:

an array of valid confidence names

Throws:

java.rmi.RemoteException - An exception occurred remotely

getValidNotificationLevelNames

java.lang.String[] getValidNotificationLevelNames()
                                                  throws java.rmi.RemoteException

Fetches a list of valid notification level names

Returns:

an array of valid notification level names

Throws:

java.rmi.RemoteException - An exception occurred remotely

getValidPhaseNames

java.lang.String[] getValidPhaseNames()
                                      throws java.rmi.RemoteException

Fetches a list of valid phase names

Returns:

an array of valid phase names

Throws:

java.rmi.RemoteException - An exception occurred remotely

getValidSeverityNames

java.lang.String[] getValidSeverityNames()
                                         throws java.rmi.RemoteException

Fetches a list of valid severity names

Returns:

an array of valid severity names

Throws:

java.rmi.RemoteException - An exception occurred remotely

getValidStatusNames

java.lang.String[] getValidStatusNames()
                                       throws java.rmi.RemoteException

Fetches a list of valid status names

Returns:

an array of valid status names

Throws:

java.rmi.RemoteException - An exception occurred remotely

getValidTypeNames

java.lang.String[] getValidTypeNames()
                                     throws java.rmi.RemoteException

Fetches a list of valid type names

Returns:

an array of valid type names

Throws:

java.rmi.RemoteException - An exception occurred remotely

postIncident

java.lang.String postIncident(org.cmis.interopserver.beans.TieIncident info,
                              org.cmis.interopserver.beans.SimpleCOG[] postToCogs,
                              org.cmis.interopserver.beans.AttachmentDescriptor[] attachments)
                              throws java.rmi.RemoteException

This method takes three arguments: an instance of TieIncident, an array of SimpleCOGs and an array of AttachmentDescriptors. The array of SimpleCOGs should not contain duplicates or the source COG in the mailing list. The return value is the ID (either provided or a DMIS-generated ID as a result of the post) for the incident and could be used in subsequent calls. Posting is the act of making incident information available to other Collaborative Operating Groups (COGs.) When an authenticated operator chooses to post information, he/she is essentially saying, “I want to make this information available to the following COGs.” In the specific example of the interoperable API, posting is the heart of sharing incident information. The interoperability API does not, per se, provide a mechanism for maintaining information. Day-to-day creation and modification of incident information can be accomplished using whatever client software the individual operator chooses. That software, using the DMI-S interoperability API, can then make it available to other DMI-S authorized users. Those users may be using either the same or different software to retrieve this data just as long as it complies with the API specification. Versioning in DMI-S facilitates the ability to capture “point-in-time” information about an incident. Each time an incident is posted, a new version is created. Old versions exist as historical records but may be accessed in the same way as current versions. Once an incident record is posted, it cannot be modified. Subsequent postings of the same information will always result in a new version of the incident being created assuming the same unique ID is used during the post operation.

Parameters:

info - Detailed incident information in the form of a TieIncident

postToCogs - COGs who will receive the incident data

attachments - An array of AttachmentDescriptors describing what will be attached to the message. Each localAbsoluteFileName should have the full path and name of a file to be sent

Returns:

returns the key for future reference of this inncident. If TieIncident.vendorUniqueId is set, the return will equal this value, otherwise DMIS will give you one.

Throws:

java.rmi.RemoteException - An exception occurred remotely