org.cmis.interopserver.services.admin
Interface Admin

All Superinterfaces:

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

All Known Implementing Classes:

AdminSoapBindingImpl, AdminSoapBindingSkeleton, AdminSoapBindingStub

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

This interface provides admin functionality for DMIS Operators

Author:

interop team

Method Summary

long	createOperator(org.cmis.interopserver.beans.CMISOperator operator) Creates the given operator.
void	deleteOperator(org.cmis.interopserver.beans.CMISOperator operator) Disables the given operator, which can not match the caller.
org.cmis.interopserver.beans.CMISOperator[]	getAllOperators() Returns list of operators in the caller's COG.
org.cmis.interopserver.beans.CMISOperator	getMyOperator() Returns the profile of the caller.
org.cmis.interopserver.beans.CMISOperator	getOperator(long operatorID) Returns the given operator for the given id.
java.lang.String[]	getValidContactTypeNames() Returns a list of valid contact types for use in editing/adding contact information for a DMIS operator.
void	saveMyOperator(org.cmis.interopserver.beans.CMISOperator operator) Saves the given operator, which must match the profile of the caller.
void	saveOperator(org.cmis.interopserver.beans.CMISOperator operator) Saves the given operator.

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

getCogs, getMyCog, ping

Method Detail

getAllOperators

org.cmis.interopserver.beans.CMISOperator[] getAllOperators()
                                                            throws java.rmi.RemoteException

Returns list of operators in the caller's COG. Should only be called by an administrator.

Returns:

A list of operators in the caller's COG.

Throws:

java.rmi.RemoteException - A remote exception occurred.

getMyOperator

org.cmis.interopserver.beans.CMISOperator getMyOperator()
                                                        throws java.rmi.RemoteException

Returns the profile of the caller.

Returns:

the profile of the caller.

Throws:

java.rmi.RemoteException - A remote exception occurred.

getOperator

org.cmis.interopserver.beans.CMISOperator getOperator(long operatorID)
                                                      throws java.rmi.RemoteException

Returns the given operator for the given id.

Parameters:

operatorID - id of the operator to be retrieved

Returns:

the given operator for the given id

Throws:

java.rmi.RemoteException

getValidContactTypeNames

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

Returns a list of valid contact types for use in editing/adding contact information for a DMIS operator.

Returns:

A String array of valid contact types

Throws:

java.rmi.RemoteException - A remote exception occurred.

createOperator

long createOperator(org.cmis.interopserver.beans.CMISOperator operator)
                    throws java.rmi.RemoteException

Creates the given operator. Should only be called by an administrator.

Parameters:

operator - Operator profile of the DMIS operator to be created. (Default permissions)

Throws:

java.rmi.RemoteException - A remote exception occurred.

deleteOperator

void deleteOperator(org.cmis.interopserver.beans.CMISOperator operator)
                    throws java.rmi.RemoteException

Disables the given operator, which can not match the caller. Should only be called by an administrator.

Parameters:

operator - A DMIS operator to be deleted

Throws:

java.rmi.RemoteException - A remote exception occurred.

saveMyOperator

void saveMyOperator(org.cmis.interopserver.beans.CMISOperator operator)
                    throws java.rmi.RemoteException

Saves the given operator, which must match the profile of the caller. If the current operator (the caller) is the given operator, some restrictions apply: you may not change admin rights, enable/disable your profile, or change your login.

Parameters:

operator - The DMIS operator profile of the caller

Throws:

java.rmi.RemoteException - When given operator is not the current.

saveOperator

void saveOperator(org.cmis.interopserver.beans.CMISOperator operator)
                  throws java.rmi.RemoteException

Saves the given operator. Should only be called by an administrator. If the current operator (the caller) is the given operator, some restrictions apply: you may not change admin rights, enable/disable your profile, or change your login.

Parameters:

operator - A DMIS operator

Throws:

java.rmi.RemoteException - A remote exception occurred.