|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object jpl.mipl.mdms.FileService.komodo.api.VFT
public class VFT
This class contains all actions that can be take on a VFT by a user.
Constructor Summary | |
---|---|
VFT(Session session,
boolean mustBeAdmin)
Constructor |
Method Summary | |
---|---|
int |
addRef(String vft,
String reference,
String link,
String comment)
Method to create the a reference in the supplied vft. |
int |
addVFT(String vft,
String title,
boolean notify)
Method to add a vft to the database. |
int |
addVFTReader(String vft,
String user)
Method to add vft reader |
int |
cancelReference(String vft,
String reference)
Method to cancel a reference change before doing a vft update. |
int |
close()
Method to close this vft channel. |
int |
deleteRef(String vft,
String ref)
Method to delete the a reference within the supplied virtual file type |
int |
deleteVFT(String vft)
Method to delete a the current virutal file type |
int |
delVFTReader(String vft,
String user)
Method to remove a reader from the supplied vft |
int |
getReference(String vft,
String reference)
Method to get the file associated with a virtual file type reference. |
int |
getReferenceAt(String vft,
String reference,
Date datetime)
Method to get the file associated with a virtual file type reference at a specified date. |
String |
getServerName()
Accessor method to return the vft server name |
int |
getVFT(String vft)
Method to get all files associated with a VFT. |
int |
getVFTAt(String vft,
Date datetime)
Method to get all files that were associated with a VFT at a particular date. |
int |
setReference(String vft,
String reference,
String fileType,
String fileName)
Method to set a reference to point to a new file on next vftUpdate. |
int |
showReference(String vft,
String ref,
Date datetime)
Method to show information about the supplied vft references. |
int |
showVFT(String vft,
Date datetime)
Method to show information about the supplied vft. |
int |
showVFTReaders(String vft,
String user)
Method to show readers allowed to access the supplied vft. |
int |
update(String vft,
String comment)
Method to update the current VFT. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public VFT(Session session, boolean mustBeAdmin) throws SessionException
session
- a transfer session, for maintining file types and
connections.mustBeAdmin
- if true, connect on admin port
SessionException
- when session failureMethod Detail |
---|
public final String getServerName()
public final int getVFT(String vft) throws SessionException
vft
- the virtual file type
SessionException
- when session failurepublic final int getVFTAt(String vft, Date datetime) throws SessionException
vft
- the virtual file typedatetime
- the date these files were in effect.
SessionException
- when session failurepublic final int getReference(String vft, String reference) throws SessionException
vft
- the vitual file typereference
- the reference name
SessionException
- when session failurepublic final int getReferenceAt(String vft, String reference, Date datetime) throws SessionException
vft
- the virtual file typereference
- the reference namedatetime
- the date filter
SessionException
- when session failurepublic final int setReference(String vft, String reference, String fileType, String fileName) throws SessionException
vft
- the virtual file typereference
- the reference namefileType
- the name of file typefileName
- the name of file to reference
SessionException
- when session failurepublic final int showVFT(String vft, Date datetime) throws SessionException
vft
- the virtual file typedatetime
- the optional date filter
SessionException
- when session failurepublic final int showReference(String vft, String ref, Date datetime) throws SessionException
vft
- the virtual file typeref
- the reference namedatetime
- the optional date filter
SessionException
- when session failurepublic final int cancelReference(String vft, String reference) throws SessionException
vft
- the virtual file typereference
- the reference name
SessionException
- when session failurepublic final int addVFTReader(String vft, String user) throws SessionException
vft
- the virtual file typeuser
- the vft reader name
SessionException
- when session failurepublic final int showVFTReaders(String vft, String user) throws SessionException
vft
- the virtual file typeuser
- the vft reader name
SessionException
- when session failurepublic final int delVFTReader(String vft, String user) throws SessionException
vft
- the virtual file typeuser
- the vft reader.
SessionException
- when session failurepublic final int close()
public final int addVFT(String vft, String title, boolean notify) throws SessionException
vft
- the virtual file typetitle
- the optional title, may be null.notify
- if true, notify a list of email addresses on update vft
SessionException
- when session failurepublic final int deleteVFT(String vft) throws SessionException
vft
- the virtual file type
SessionException
- when session failurepublic final int addRef(String vft, String reference, String link, String comment) throws SessionException
vft
- the virtual file typereference
- new reference namelink
- the optional linkcomment
- the optional comment
SessionException
- when session failurepublic final int deleteRef(String vft, String ref) throws SessionException
vft
- the virtual file typeref
- the reference name
SessionException
- when session failurepublic final int update(String vft, String comment)
vft
- the virtual file typecomment
- the optional comment (may be null)
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |