Enterprise Information Portal APIs

com.ibm.mm.sdk.common
Class DKMimetypeMgmtFed

java.lang.Object
  |
  +--com.ibm.mm.sdk.common.DKMimetypeMgmtFed
All Implemented Interfaces:
DKConstant, DKConstantFed, DKMessageId, DKMessageIdFed, java.io.Serializable

public class DKMimetypeMgmtFed
extends java.lang.Object
implements java.io.Serializable, DKMessageIdFed, DKConstantFed

See Also:
Serialized Form

Fields inherited from interface com.ibm.mm.sdk.common.DKMessageIdFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKMessageId
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstantFed
    For details, see the class or interface
 
Fields inherited from interface com.ibm.mm.sdk.common.DKConstant
    For details, see the class or interface
 
Constructor Summary
DKMimetypeMgmtFed()
          Default constructor
DKMimetypeMgmtFed(dkDatastore ds, int accessLevel)
          Constructor with datastore reference
 
Method Summary
 void addCC2Mime(DKCC2MimeFed cc2MimeObj)
          Adds a new ContentClass/File Extension association to Mime key to the database
 void addMime2App(DKMime2AppFed mimeObj)
          Adds mimetype to application object
 void clearCache()
          Clears current cache data
 DKCC2MimeFed getCC2Mime(java.lang.String key)
          Gets a content class, file extension, or column name with mimetype association information based on the key
 dkDatastore getDatastore()
          Gets the datastore object
 DKMime2AppFed getMime2App(java.lang.String mimetype)
          Gets a mimetype to application information based on the mimetype
 java.util.Vector getMimeTypes()
          Get a list of available mimetypes that we know of from federated database
 dkCollection listAllCC2Mimes()
          Gets a list of DKCC2MimeFed objects defined in EIP server
 dkCollection listCC2Mimes(java.lang.String dsType)
          Gets a list of DKCC2MimeFed objects defined in EIP server for this given datastore type.
 dkCollection listMime2Apps()
          Gets a list of Mime2App objects
 void removeAllCC2Mimes()
          Removes all CC2Mime data from federated database
 void removeAllMime2Apps()
          Removes all mime2app association in EIP database
 void removeCC2Mime(java.lang.String key)
          Removes a CC to Mime key from the database
 void removeMime2App(DKMime2AppFed mimeObj)
          Removes a mimetype to application association from EIP database
 void removeMime2App(java.lang.String mimetype)
          deletes a mimetype to application information based on the mimetype
 void setDatastore(dkDatastore ds)
          Sets the datastore object
 void updateCC2Mime(DKCC2MimeFed cc2MimeObj)
          Updates given CC2Mime data from EIP server
 void updateMime2App(DKMime2AppFed mimeObj)
          Updates the given mime2app association in EIP database
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DKMimetypeMgmtFed

public DKMimetypeMgmtFed()
Default constructor

DKMimetypeMgmtFed

public DKMimetypeMgmtFed(dkDatastore ds,
                         int accessLevel)
                  throws DKException,
                         java.lang.Exception
Constructor with datastore reference
Parameters:
ds - dkDatastore - datastore object
Method Detail

setDatastore

public void setDatastore(dkDatastore ds)
                  throws DKException,
                         java.lang.Exception
Sets the datastore object
Parameters:
ds - dkDatastore - datastore object

getDatastore

public dkDatastore getDatastore()
Gets the datastore object
Returns:
dkDatastore object

listMime2Apps

public dkCollection listMime2Apps()
                           throws DKException
Gets a list of Mime2App objects
Returns:
a collection of DKMime2AppFed objects
Throws:
DKException -  

getMime2App

public DKMime2AppFed getMime2App(java.lang.String mimetype)
                          throws DKNotExistException,
                                 DKException
Gets a mimetype to application information based on the mimetype
Parameters:
mimetype -  
Returns:
DKMime2AppFed object

removeMime2App

public void removeMime2App(java.lang.String mimetype)
                    throws DKNotExistException,
                           DKException
deletes a mimetype to application information based on the mimetype
Parameters:
mimetype -  

addMime2App

public void addMime2App(DKMime2AppFed mimeObj)
                 throws DKAlreadyExistException,
                        DKException
Adds mimetype to application object
Parameters:
mimeObj - DKMime2AppFed object

removeMime2App

public void removeMime2App(DKMime2AppFed mimeObj)
                    throws DKNotExistException,
                           DKException
Removes a mimetype to application association from EIP database
Parameters:
mimeObj - DKMime2AppFed object

updateMime2App

public void updateMime2App(DKMime2AppFed mimeObj)
                    throws DKException
Updates the given mime2app association in EIP database
Parameters:
mimeObj - DKMime2AppFed object to be updated
Throws:
DKException - when error occurs in the EIP server

removeAllMime2Apps

public void removeAllMime2Apps()
                        throws DKException
Removes all mime2app association in EIP database

listAllCC2Mimes

public dkCollection listAllCC2Mimes()
                             throws DKException
Gets a list of DKCC2MimeFed objects defined in EIP server
Returns:
a collection of DKCC2MimeFed objects
Throws:
DKException - server internal error

listCC2Mimes

public dkCollection listCC2Mimes(java.lang.String dsType)
                          throws DKException
Gets a list of DKCC2MimeFed objects defined in EIP server for this given datastore type.
Parameters:
dsType - String - datastore type
Returns:
a collection of DKCC2MimeFed objects
Throws:
DKException - server internal error

getCC2Mime

public DKCC2MimeFed getCC2Mime(java.lang.String key)
                        throws DKNotExistException,
                               DKException
Gets a content class, file extension, or column name with mimetype association information based on the key
Parameters:
key - a string representation of the CC2Mime key. This key could be one of the following format: String key = DSType + "." + Server_ContentClass_Value; or String key = DSType + "." + document_extension; //for OnDemand
Returns:
DKCC2MimeFed object

addCC2Mime

public void addCC2Mime(DKCC2MimeFed cc2MimeObj)
                throws DKAlreadyExistException,
                       DKException
Adds a new ContentClass/File Extension association to Mime key to the database
Parameters:
cc2MimeObj - DKCC2MimeFed object to be added
Throws:
DKAlreadyExistException - if the given key already exists
DKException - if the error occurs in the server

removeCC2Mime

public void removeCC2Mime(java.lang.String key)
                   throws DKNotExistException,
                          DKException
Removes a CC to Mime key from the database
Parameters:
key - a string representation of the CC2Mime key. This key could be one of the following format: String key = DSType + "." + Server_ContentClass_Value; or String key = DSType + "." + document_extension; //for OnDemand
Throws:
DKNotExistException - if the given key does not exist
DKException - if the error occurs in the server

removeAllCC2Mimes

public void removeAllCC2Mimes()
                       throws DKException
Removes all CC2Mime data from federated database
Throws:
DKException - if error occurs in the server

updateCC2Mime

public void updateCC2Mime(DKCC2MimeFed cc2MimeObj)
                   throws DKException,
                          java.lang.Exception
Updates given CC2Mime data from EIP server
Parameters:
cc2MimeObj - DKCC2MimeFed - cc2mime object to be updated
Throws:
DKException - if error occurs in the server

getMimeTypes

public java.util.Vector getMimeTypes()
                              throws DKException,
                                     java.lang.Exception
Get a list of available mimetypes that we know of from federated database
Throws:
DKException - if error occurs in the server

clearCache

public void clearCache()
Clears current cache data

EIP Java APIs

(c) Copyright International Business Machines Corporation 1996, 2002. IBM Corp. All rights reserved.