All Packages  Class Hierarchy  This Package  Previous  Next  Index

Class icc.face.DocumentsPage

java.lang.Object
   |
   +----icc.face.Presenter
           |
           +----icc.face.DocumentsPage

public final class DocumentsPage

extends Presenter

See Also:

File, Header

CREATION

A useful constant to specify an additional overview field.

DOCTYPE

A useful constant to retrieve or specify a document's bibliographic reference type.

FORMAT

A useful constant to retrieve or specify a document's format name, or to specify an additional overview field.

LEDIT

A useful constant to specify an additional overview field.

PREVIEW

A useful constant to retrieve or specify a document's preview field.

READER

A useful constant to retrieve or specify a collaborative author type.

WRITER

A useful constant to retrieve or specify a collaborative author type.

DocumentsPage(Client, Handler, String, String, boolean)

Allocates a DocumentsPage object for the specified client applet and handler and with the specified display name and url.

attributes(File)

Returns an array of attribute names for the specified document, if any.

bibrefAttributes(String)

Returns an array of bibliographic reference attribute names for the specified document type.

bibrefAuthors(File)

bibrefLabels(String)

Returns an array of bibliographic reference attribute labels for the specified document type.

categories(File)

Returns an array of categories for the specified document, if any.

clearTags()

Clears all tags.

clearVisibles()

Clears all visibles.

contains(int, Integer)

Returns whether the folder with given index contains the specified document.

deleteDocument(Integer)

Sends a request to delete the document information for the specified identifier to the mediator, if the user has delete permission for this document.

doctypes()

Returns an array of document types for bibliographic reference information.

documents(int)

Returns an array of document identifiers corresponding to the top-level documents in the specified folder.

editNew(Integer)

Sets this information to a new document being edited.

editNewText(Integer)

Sets this information to a new text document being edited.

editNewVersion(Integer)

Sets this information to a new document being edited.

editOn()

Returns whether this document is being edited or not.

exists(int)

Returns whether the project cube corresponding the specified folder has access rights defined.

foldersSize()

Returns the number of folders currently held.

formats()

Returns an array of format names.

getArea()

Returns the current project area.

getArea(int)

Returns the project area for the folder with given index.

getCategories(int)

Returns the categories for the folder with given index.

getDocument()

Returns the current document information.

getDocument(Integer)

Returns the document information for the specified identifier.

getEditDocumentName()

Returns the name of the currently or previously edited document.

getFolder(int)

Returns the folder with given index.

getFormat(File)

Returns the format document corresponding the specified document, if any.

getMembers(Integer)

Returns an array of team members for the specified team.

getOverview()

Returns the additional overview field name.

getPreview(File)

Returns the preview URL for the specified document, if any.

getProjectName()

Returns the current project name.

getProjectName(int)

Returns the project name for the folder with given index.

getSize(int)

Returns the number of documents for the folder with given index.

getTime()

Returns the current project time.

getTime(int)

Returns the project time for the folder with given index.

getType()

Returns the current project type.

getType(int)

Returns the project type for the folder with given index.

getUsername(Integer)

Returns the username corresponding the specified partner identifier, or "unknown" if the partner is unknown.

isBibref(Header)

Checks whether the specified document information concerns a bibliographic reference or not.

isComplete(Header)

Checks whether the specified document information concerns a full document or document header.

isFolderOpen(int)

Checks whether the specified folder is shown including all documents, or not.

isOpen(Integer)

Checks whether the specified document is shown including all contained and follow-up documents, or not.

isTagged(Integer)

Checks whether the specified document is tagged or not.

isText(Header)

Checks whether the specified document information concerns a text document or not.

isVisible(Integer)

Checks whether the specified document is visible or not.

isWork(Header)

Checks whether the specified document information concerns a work document or not.

links(File)

Returns an array of link identifiers for the specified document, if any.

mayDelete(File)

Returns whether the user has write permission for the specified document.

mayRead(File)

Returns whether the user has read permission for the specified document.

mayRead(int)

Returns whether the user has read permission for the specified folder.

mayWrite(File)

Returns whether the user has write permission for the specified document.

mayWrite(int)

Returns whether the user has write permission for the specified folder.

moveFolderDown(int)

Moves the specified folder down one index.

moveFolderUp(int)

Moves the specified folder up one index.

nextDocument(Integer)

Returns the next document in the current folder, if any.

overviews()

Returns an array of valid overview field names.

previousDocument(Integer)

Returns the previous document in the current folder, if any.

readers(WorkFile)

reference(File)

removeFolder(int)

Removes the specified folder.

reservedAttributes()

Returns an array of reserved attribute names for documents that do not contain bibliographic reference information.

reservedBibrefAttributes()

Returns an array of additional reserved attribute names for documents that do contain bibliographic reference information.

retrieve(Integer)

Sends a request to retrieve the document information for the specified identifier to the mediator.

retrieve(Integer[])

Sends a request to retrieve all document information for the specified identifiers to the mediator.

setBibrefAuthors(String)

setDocument(Integer)

Sets the current document.

setFolder(Folder)

Sets the current folder.

setOverview(String)

Sets the current overview field name.

submit()

Submits the edited document information for confirmation to the project database.

tags()

Returns an array of all tagged and visible document identifiers.

teams()

Returns an array of teams.

toggleBibref()

Toggles whether this information concerns a bibliographic reference document or not.

toggleEdit()

Toggles whether this information is being edited or not.

toggleFolderOpen(int)

Toggles whether the specified folder is shown including all documents, or not.

toggleLock(Integer)

Toggles the lock of a file.

toggleOpen(Integer)

Toggles whether the specified document is shown including all contained and follow-up documents, or not.

toggleTag(Integer)

Toggles whether the specified document is tagged or not.

toggleVisible(Integer)

Toggles whether the specified document is visible or not.

toggleWork()

Toggles whether this information concerns a work document or not.

userId()

Returns the user's partner identifier, or null if the user authenticated as guest.

writers(WorkFile)

 public final String FORMAT

A useful constant to retrieve or specify a document's format name, or to specify an additional overview field.

 public final String CREATION

A useful constant to specify an additional overview field.

 public final String LEDIT

A useful constant to specify an additional overview field.

 public final String PREVIEW

A useful constant to retrieve or specify a document's preview field.

 public final String DOCTYPE

A useful constant to retrieve or specify a document's bibliographic reference type.

 public final String WRITER

A useful constant to retrieve or specify a collaborative author type.

 public final String READER

A useful constant to retrieve or specify a collaborative author type.

 public DocumentsPage(Client client,
                      Handler handler,
                      String display,
                      String url,
                      boolean hold)

Allocates a DocumentsPage object for the specified client applet and handler and with the specified display name and url.

Parameters:

client - the client applet

handler - the client handler

display - a display name

url - a url to be published in this display

hold - a boolean to specify whether the previous folder(s) should be held when a new current folder is set

 public String getProjectName()

Returns the current project name.

Returns:

a project name

 public String getArea()

Returns the current project area.

Returns:

a project area

 public String getTime()

Returns the current project time.

Returns:

a project time

 public String getType()

Returns the current project type.

Returns:

a project type

 public Header getDocument()

Returns the current document information.

Returns:

a document

 public boolean editOn()

Returns whether this document is being edited or not.

Returns:

true if this document is being edited, false otherwise.

 public int foldersSize()

Returns the number of folders currently held.

Returns:

the number of folders

 public String[] formats()

Returns an array of format names.

Returns:

an array of format names

 public String[] doctypes()

Returns an array of document types for bibliographic reference information.

Returns:

an array of document types

 public String[] bibrefAttributes(String type)

Returns an array of bibliographic reference attribute names for the specified document type.

Parameters:

type - a bibliographic reference document type

Returns:

an array of attribute names

 public String[] bibrefLabels(String type)

Returns an array of bibliographic reference attribute labels for the specified document type.

Parameters:

type - a bibliographic reference document type

Returns:

an array of attribute labels

 public String[] overviews()

Returns an array of valid overview field names.

Returns:

an array of valid overview field names

 public String getOverview()

Returns the additional overview field name.

Returns:

an overview field name

 public Folder getFolder(int index)

Returns the folder with given index.

Parameters:

index - a folder index

Returns:

a folder

 public String getProjectName(int index)

Returns the project name for the folder with given index.

Parameters:

index - a folder index

Returns:

a project name

 public String getArea(int index)

Returns the project area for the folder with given index.

Parameters:

index - a folder index

Returns:

a project area

 public String getTime(int index)

Returns the project time for the folder with given index.

Parameters:

index - a folder index

Returns:

a project time

 public String getType(int index)

Returns the project type for the folder with given index.

Parameters:

index - a folder index

Returns:

a project type

 public String getCategories(int index)

Returns the categories for the folder with given index.

Parameters:

index - a folder index

Returns:

a string of categories separated with spaces

See Also:

getCategories

 public int getSize(int index)

Returns the number of documents for the folder with given index.

Parameters:

index - a folder index

Returns:

the number of documents

See Also:

size

 public boolean contains(int index,
                         Integer id)

Returns whether the folder with given index contains the specified document.

Parameters:

index - a folder index

id - a document identifier

Returns:

true if this folder contains the document; false otherwise

See Also:

contains

 public void toggleLock(Integer id)

Toggles the lock of a file.

Parameters:

index - a folder index

 public boolean mayRead(int index)

Returns whether the user has read permission for the specified folder.

Parameters:

index - a folder index

Returns:

true if the user has read permission, false otherwise

 public boolean mayWrite(int index)

Returns whether the user has write permission for the specified folder.

Parameters:

index - a folder index

Returns:

true if the user has write permission, false otherwise

 public boolean exists(int index)

Returns whether the project cube corresponding the specified folder has access rights defined.

Parameters:

index - a folder index

Returns:

true if the project cube exists, false otherwise

 public Header getDocument(Integer id)

Returns the document information for the specified identifier.

Parameters:

id - a document identifier

Returns:

a document

 public boolean isComplete(Header doc)

Checks whether the specified document information concerns a full document or document header.

Parameters:

doc - a document

Returns:

true if a full document is concerned, false otherwise

 public boolean isWork(Header doc)

Checks whether the specified document information concerns a work document or not.

Parameters:

doc - a document

Returns:

true if a work document is concerned, false otherwise

 public boolean isText(Header doc)

Checks whether the specified document information concerns a text document or not.

Parameters:

doc - a document

Returns:

true if a text document is concerned, false otherwise

 public boolean isBibref(Header doc)

Checks whether the specified document information concerns a bibliographic reference or not.

Parameters:

doc - a document

Returns:

true if a bibliographic reference is concerned, false otherwise

 public boolean mayRead(File doc)

Returns whether the user has read permission for the specified document. This document must belong to the current folder.

Parameters:

doc - a full document

Returns:

true if the user has read permission, false otherwise

 public boolean mayWrite(File doc)

Returns whether the user has write permission for the specified document. This document must belong to the current folder.

Parameters:

doc - a full document

Returns:

true if the user has write permission, false otherwise

 public boolean mayDelete(File doc)

Returns whether the user has write permission for the specified document. This document must belong to the current folder.

Parameters:

doc - a full document

Returns:

true if the user has write permission, false otherwise

 public String getPreview(File doc)

Returns the preview URL for the specified document, if any.

Parameters:

doc - a full document

Returns:

a URL

 public Header getFormat(File doc)

Returns the format document corresponding the specified document, if any.

Parameters:

doc - a full document

Returns:

a format document

 public void setOverview(String field)

Sets the current overview field name. If the field name is null no additional overview field should be shown.

Parameters:

field - an overview field name

See Also:

FORMAT, CREATION, LAST_EDIT

 public String[] categories(File doc)

Returns an array of categories for the specified document, if any.

Parameters:

doc - a full document

Returns:

an array of categories

 public String[] reservedAttributes()

Returns an array of reserved attribute names for documents that do not contain bibliographic reference information.

Returns:

an array of attribute names

 public String[] reservedBibrefAttributes()

Returns an array of additional reserved attribute names for documents that do contain bibliographic reference information.

Returns:

an array of attribute names

 public synchronized String[] attributes(File doc)

Returns an array of attribute names for the specified document, if any. Preview, format and bibliographic reference attributes are excluded.

Parameters:

doc - a full document

Returns:

an array of attribute names

 public synchronized Integer[] links(File doc)

Returns an array of link identifiers for the specified document, if any.

Parameters:

doc - a full document

Returns:

an array of link identifiers

 public String reference(File doc)

 public synchronized String[] bibrefAuthors(File doc)

 public synchronized String[] writers(WorkFile doc)

 public synchronized String[] readers(WorkFile doc)

 public void setBibrefAuthors(String authors)

 public void setDocument(Integer id)

Sets the current document. This document must belong to the current folder.

Parameters:

id - a document identifier

 public Integer[] documents(int index)

Returns an array of document identifiers corresponding to the top-level documents in the specified folder.

Parameters:

index - a folder index

Returns:

an array of document identifiers

 public synchronized void setFolder(Folder folder)

Sets the current folder. The current document is set to null.

Parameters:

a - folder

 public synchronized void removeFolder(int index)

Removes the specified folder. The current document is set to null if this concerns the current folder.

Parameters:

index - a folder index

 public synchronized void moveFolderUp(int index)

Moves the specified folder up one index. The current document is set to null if this changes the current folder.

Parameters:

index - a folder index

 public synchronized void moveFolderDown(int index)

Moves the specified folder down one index. The current document is set to null if this changes the current folder.

Parameters:

index - a folder index

 public String getEditDocumentName()

Returns the name of the currently or previously edited document.

 public void toggleEdit()

Toggles whether this information is being edited or not.

 public void toggleWork()

Toggles whether this information concerns a work document or not. This document must be being edited.

 public void toggleBibref()

Toggles whether this information concerns a bibliographic reference document or not. This document must be being edited.

 public void editNew(Integer id)

Sets this information to a new document being edited. If a parent document is specified, the new document is set to belong to the specified document.

Parameters:

id - a document identifier, or null

 public void editNewVersion(Integer id)

Sets this information to a new document being edited. If a parent document is specified, the new document is set to be a new version of the specified document.

Parameters:

id - a document identifier, or null

 public void editNewText(Integer id)

Sets this information to a new text document being edited. If a parent document is specified, the new document is set to reply to the specified document.

Parameters:

id - a document identifier, or null

 public boolean isTagged(Integer id)

Checks whether the specified document is tagged or not.

Parameters:

id - a document identifier

Returns:

true if the document is tagged, false otherwise

 public void toggleTag(Integer id)

Toggles whether the specified document is tagged or not.

Parameters:

id - a document identifier

 public boolean isVisible(Integer id)

Checks whether the specified document is visible or not.

Parameters:

id - a document identifier

Returns:

true if the document is visible, false otherwise

 public void toggleVisible(Integer id)

Toggles whether the specified document is visible or not.

Parameters:

id - a document identifier

 public Integer[] tags()

Returns an array of all tagged and visible document identifiers.

Returns:

an array of document identifiers

 public void clearTags()

Clears all tags.

 public void clearVisibles()

Clears all visibles.

 public boolean isOpen(Integer id)

Checks whether the specified document is shown including all contained and follow-up documents, or not.

Parameters:

id - a document identifier

Returns:

true if the document is open, false otherwise

 public synchronized boolean isFolderOpen(int index)

Checks whether the specified folder is shown including all documents, or not.

Parameters:

index - a folder index

Returns:

true if the folder is open, false otherwise

 public void toggleOpen(Integer id)

Toggles whether the specified document is shown including all contained and follow-up documents, or not.

Parameters:

id - a document identifier

 public synchronized void toggleFolderOpen(int index)

Toggles whether the specified folder is shown including all documents, or not.

Parameters:

index - a folder index

 public Header previousDocument(Integer id)

Returns the previous document in the current folder, if any.

Parameters:

id - a document identifier

Returns:

the resulting document information; null otherwise.

 public Header nextDocument(Integer id)

Returns the next document in the current folder, if any.

Parameters:

id - a document identifier

Returns:

the resulting document information; null otherwise.

 public boolean submit()

Submits the edited document information for confirmation to the project database. If any necessary information is missing or incomplete, the information is not submitted.

Returns:

true if the information is submitted; false otherwise

See Also:

alter, create

 public Integer[] teams()

Returns an array of teams.

Returns:

an array of team identifiers

 public Integer[] getMembers(Integer id)

Returns an array of team members for the specified team.

Returns:

an array of team member identifiers

 public void retrieve(Integer id)

Sends a request to retrieve the document information for the specified identifier to the mediator.

Parameters:

id - a document identifier

See Also:

retrieve, query

 public void retrieve(Integer ids[])

Sends a request to retrieve all document information for the specified identifiers to the mediator.

Parameters:

ids - an array of document identifiers

See Also:

retrieve, query

 public void deleteDocument(Integer id)

Sends a request to delete the document information for the specified identifier to the mediator, if the user has delete permission for this document.

Parameters:

id - a document identifier

See Also:

delete, query

 public Integer userId()

Returns the user's partner identifier, or null if the user authenticated as guest.

Returns:

a partner identifier

 public String getUsername(Integer id)

Returns the username corresponding the specified partner identifier, or "unknown" if the partner is unknown.

Parameters:

id - a partner identifier

Returns:

a partner username

All Packages  Class Hierarchy  This Package  Previous  Next  Index