com.openexchange.admin.rmi
Interface OXPublicationInterface

All Superinterfaces:
java.rmi.Remote

public interface OXPublicationInterface
extends java.rmi.Remote

This interface defines methods for checking and deleting Publications by Users.

Example:

 final OXPublicationInterface iface = (OXPublicationInterface)Naming.lookup("rmi:///oxhost/"+OXPublicationInterface.RMI_NAME);
 

Author:
Felix Marx, Ioannis Chouklis

Field Summary
static java.lang.String RMI_NAME
          RMI name to be used in the naming lookup.
 
Method Summary
 Publication deletePublication(Context ctx, Credentials credentials, int publicationId)
          Deletes the publication with the specified identifier
 Publication deletePublication(Context ctx, Credentials credentials, java.lang.String url)
          Deletes a Publication
 boolean deletePublication(Context ctx, java.lang.String url, Credentials credentials)
          Deprecated. Use OXPublicationInterface.deletePublication(Context ctx, Credentials credentials, String url) instead
 java.util.List<Publication> deletePublications(Context ctx, Credentials credentials)
          Deletes all publications in the specified context
 java.util.List<Publication> deletePublications(Context ctx, Credentials credentials, int user)
          Deletes all Publications for the specified user
 java.util.List<Publication> deletePublications(Context ctx, Credentials credentials, int user, java.lang.String module)
          Delete all publications for the specified user in the specified context for the specified module
 java.util.List<Publication> deletePublications(Context ctx, Credentials credentials, java.lang.String entityId)
          Delete all publications in the specified context with the specified entity identifier
 Publication getPublication(Context ctx, java.lang.String url, Credentials credentials)
          Gets a Publication for a given URL
 java.util.List<Publication> listPublications(Context ctx, Credentials credentials)
          Lists all publications in the specified context
 java.util.List<Publication> listPublications(Context ctx, Credentials credentials, int user)
          Lists all publications for the specified user in the specified context
 java.util.List<Publication> listPublications(Context ctx, Credentials credentials, int user, java.lang.String module)
          Lists all publications for the specified user in the specified context for the specified module
 java.util.List<Publication> listPublications(Context ctx, Credentials credentials, java.lang.String entityId)
          List all publications in the specified context with the specified entity identifier
 

Field Detail

RMI_NAME

static final java.lang.String RMI_NAME
RMI name to be used in the naming lookup.

See Also:
Constant Field Values
Method Detail

getPublication

Publication getPublication(Context ctx,
                           java.lang.String url,
                           Credentials credentials)
                           throws java.rmi.RemoteException,
                                  NoSuchPublicationException,
                                  MissingServiceException
Gets a Publication for a given URL

Returns:
Publication if Publication is found
Throws:
OXException
NoSuchPublicationException
MissingServiceException
java.rmi.RemoteException

listPublications

java.util.List<Publication> listPublications(Context ctx,
                                             Credentials credentials)
                                             throws java.rmi.RemoteException,
                                                    NoSuchPublicationException,
                                                    MissingServiceException
Lists all publications in the specified context

Parameters:
ctx - The context
credentials - The context administrative credentials
Returns:
A Collection with all publications in the specified context
Throws:
java.rmi.RemoteException
NoSuchPublicationException
MissingServiceException

listPublications

java.util.List<Publication> listPublications(Context ctx,
                                             Credentials credentials,
                                             java.lang.String entityId)
                                             throws java.rmi.RemoteException,
                                                    NoSuchPublicationException,
                                                    MissingServiceException
List all publications in the specified context with the specified entity identifier

Parameters:
ctx - The context
credentials - The credentials
entityId - The entity identifier
Returns:
A Collection with all publications in the specified context with the specified entity identifier
Throws:
java.rmi.RemoteException
NoSuchPublicationException
MissingServiceException

listPublications

java.util.List<Publication> listPublications(Context ctx,
                                             Credentials credentials,
                                             int user,
                                             java.lang.String module)
                                             throws java.rmi.RemoteException,
                                                    NoSuchPublicationException,
                                                    MissingServiceException
Lists all publications for the specified user in the specified context for the specified module

Parameters:
ctx - The context
credentials - The context's administrative credentials
user - The user identifier
module - The module name
Returns:
A Collection with all user publications in the specified context for the specified module
Throws:
java.rmi.RemoteException
NoSuchPublicationException
MissingServiceException

listPublications

java.util.List<Publication> listPublications(Context ctx,
                                             Credentials credentials,
                                             int user)
                                             throws java.rmi.RemoteException,
                                                    NoSuchPublicationException,
                                                    MissingServiceException
Lists all publications for the specified user in the specified context

Parameters:
ctx - The context
credentials - The context's administrative credentials
user - The user identifier
Returns:
A Collection with all user publications in the specified context for the specified module
Throws:
java.rmi.RemoteException
NoSuchPublicationException
MissingServiceException

deletePublication

boolean deletePublication(Context ctx,
                          java.lang.String url,
                          Credentials credentials)
                          throws java.rmi.RemoteException,
                                 NoSuchPublicationException,
                                 MissingServiceException
Deprecated. Use OXPublicationInterface.deletePublication(Context ctx, Credentials credentials, String url) instead

Deletes a Publication

Returns:
true if the publication is deleted; false otherwise
Throws:
OXException
NoSuchPublicationException
MissingServiceException
java.rmi.RemoteException

deletePublications

java.util.List<Publication> deletePublications(Context ctx,
                                               Credentials credentials,
                                               int user)
                                               throws java.rmi.RemoteException,
                                                      NoSuchPublicationException,
                                                      MissingServiceException
Deletes all Publications for the specified user

Parameters:
ctx - The context
credentials - The context's administrative credentials
user - The user identifier
Throws:
java.rmi.RemoteException
NoSuchPublicationException
MissingServiceException

deletePublication

Publication deletePublication(Context ctx,
                              Credentials credentials,
                              int publicationId)
                              throws java.rmi.RemoteException,
                                     NoSuchPublicationException,
                                     MissingServiceException
Deletes the publication with the specified identifier

Parameters:
ctx - The context
credentials - The context's administrative credentials
publicationId - The publication identifier
Returns:
the publication that was deleted
Throws:
java.rmi.RemoteException
NoSuchPublicationException
MissingServiceException

deletePublications

java.util.List<Publication> deletePublications(Context ctx,
                                               Credentials credentials,
                                               java.lang.String entityId)
                                               throws java.rmi.RemoteException,
                                                      NoSuchPublicationException,
                                                      MissingServiceException
Delete all publications in the specified context with the specified entity identifier

Parameters:
ctx - The context
credentials - The context's administrative credentials
entityId - The entity identifier
Throws:
java.rmi.RemoteException
NoSuchPublicationException
MissingServiceException

deletePublications

java.util.List<Publication> deletePublications(Context ctx,
                                               Credentials credentials,
                                               int user,
                                               java.lang.String module)
                                               throws java.rmi.RemoteException,
                                                      NoSuchPublicationException,
                                                      MissingServiceException
Delete all publications for the specified user in the specified context for the specified module

Parameters:
ctx - The context
credentials - The context's administrative credentials
user - The user identifier
module - The module name
Throws:
java.rmi.RemoteException
NoSuchPublicationException
MissingServiceException

deletePublications

java.util.List<Publication> deletePublications(Context ctx,
                                               Credentials credentials)
                                               throws java.rmi.RemoteException,
                                                      NoSuchPublicationException,
                                                      MissingServiceException
Deletes all publications in the specified context

Parameters:
ctx - The context
credentials - The context's administrative credentials
Returns:
A list with all publication ids that were deleted
Throws:
java.rmi.RemoteException
NoSuchPublicationException
MissingServiceException

deletePublication

Publication deletePublication(Context ctx,
                              Credentials credentials,
                              java.lang.String url)
                              throws java.rmi.RemoteException,
                                     NoSuchPublicationException,
                                     MissingServiceException
Deletes a Publication

Returns:
the publication that was deleted
Throws:
OXException
NoSuchPublicationException
MissingServiceException
java.rmi.RemoteException