class: ViewItemFull

public class: ViewItemFull
Author: Tobias Schraut, created 03.09.2007
Project: Phase: 1.0; Status: Proposed; Version: : $Revision: 2722 $ $LastChangedDate: 2009-06-04 1; Complexity: 1
Dates: Created: 16.07.2009 15:34:02; Modified: 16.07.2009 15:34:02;
Flags: Active: false; IsRoot: false; IsLeaf: false;
Extension Points:
UUID: {175CA68B-DADC-4637-B915-F336E89A6CB5}
Backing bean for ViewItemFull.jspf (for viewing items in a full context).
 

Goto: Custom Properties, Fields, Methods

Extends: FacesBean

See also: LoginHelper, PubItemVOPresentation, PubItemDepositing, PubItemSimpleStatistics, FacesBean

Appears in: viewItem

Connections
 
Custom Properties
 
ViewItemFull Attributes
Attribute Details
private UIXIterator
  abstractIterator
Initial: new UIXIterator()
private List
  affiliatedOrganizationsList
Notes: The list of affiliated organizations in a list.
public static const String
  ALTERNATIVE_MODERATOR_EMAIL
Initial: "pubman-support@gwdg.de"
public static const String
  BEAN_NAME
Initial: "ViewItemFull"
private String
  citationURL
Notes: The url used for the citation
private ContextVO
  context
Initial: null
private UIXIterator
  creatorAffiliationsIterator
Initial: new UIXIterator()
private ArrayList
  creatorArray
Notes: The list of formatted creators in an ArrayList.
private ArrayList
  creatorOrganizationsArray
Notes: The list of formatted creators which are organizations in an ArrayList.
private UIXIterator
  creatorOrganizationsIterator
Initial: new UIXIterator()
private UIXIterator
  creatorPersonsIterator
Initial: new UIXIterator()
private UIXIterator
  eventAltTitleIterator
Initial: new UIXIterator()
private UIXIterator
  fileIterator
Initial: new UIXIterator()
private ArrayList
  fileList
Initial: new ArrayList()
private UIXIterator
  fileSearchHitIterator
Initial: new UIXIterator()
private static const String
  FUNCTION_MODIFY
Initial: "modify"
Notes: Added by DiT: constant for the function modify and new revision to check the rights and/or if the function has to be disabled (DiT)
private static const String
  FUNCTION_NEW_REVISION
Initial: "new_revision"
private String
  fwUrl
Notes: The url of the Coreservice for file downloads
private boolean
  isCreateNewRevisionDisabled
public boolean
  isDepositor
Initial: false
private boolean
  isFromEasySubmission
public static const String
  ISI_KNOWLEDGE_BASE_LINK
Initial: "http://gateway.isiknowledge.com/gateway/Gateway.cgi?GWVersion=2&SrcAuth=SFX&SrcApp=SFX&DestLinkType=FullRecord&KeyUT="
public static const String
  ISI_KNOWLEDGE_DEST_APP
Initial: "&DestApp=WOS"
private boolean
  isLatestRelease
private boolean
  isLatestVersion
private boolean
  isLoggedIn
public boolean
  isModerator
Initial: false
private boolean
  isModifyDisabled
private boolean
  isOwner
public boolean
  isPrivilegedViewer
Initial: false
private boolean
  isPublicStateReleased
private boolean
  isStateInRevision
private boolean
  isStatePending
private boolean
  isStateReleased
private boolean
  isStateSubmitted
private boolean
  isStateWithdrawn
Notes: Properties for action links rendering conditions
private boolean
  isWorkflowSimple
private boolean
  isWorkflowStandard
private String
  itemPattern
Notes: Version and ObjectId of the item
private ItemValidating
  itemValidating
Initial: null
Notes: Validation Service
private UIXIterator
  languagesIterator
Initial: new UIXIterator()
public static const String
  LOAD_VIEWITEM
Initial: "loadViewItem"
Notes: Faces navigation string
private UIXIterator
  locatorIterator
Initial: new UIXIterator()
private ArrayList
  locatorList
Initial: new ArrayList()
private static Logger
  logger
Initial: Logger.getLogger(ViewItemFull.class)
private LoginHelper
  loginHelper
private ArrayList
  organizationArray
Notes: The list of formatted organzations in an ArrayList.
private ArrayList
  organizationList
Notes: The list of affiliated organizations as VO List.
private HtmlPanelGroup
  panelItemFull
Initial: new HtmlPanelGroup()
public static const String
  PARAMETERNAME_ITEM_ID
Initial: "itemId"
public static const String
  PARAMETERNAME_MENU_VIEW
Initial: "view"
private PubItemVOPresentation
  pubItem
Initial: null
private PubItemDepositing
  pubItemDepositing
private PubItemSimpleStatistics
  pubManStatistics
Notes: private boolean hasRevision;
private UIXIterator
  sourceCreatorAffiliationsIterator
Initial: new UIXIterator()
private UIXIterator
  sourceCreatorOrganizationsIterator
Initial: new UIXIterator()
private UIXIterator
  sourceCreatorPersonsIterator
Initial: new UIXIterator()
private UIXIterator
  sourceIterator
Initial: new UIXIterator()
private ArrayList
  sourceList
Initial: new ArrayList()
private UIXIterator
  sourceTitleIterator
Initial: new UIXIterator()
private UIXIterator
  subjectIterator
Initial: new UIXIterator()
private UIXIterator
  titleIterator
Initial: new UIXIterator()
private String
  unapiApa
private String
  unapiBibtex
private String
  unapiEndnote
private String
  unapiEscidoc
private String
  unapiURLdownload
Notes: unapi
private String
  unapiURLview
private static const String
  VALIDATION_ERROR_MESSAGE
Initial: "depositorWS_NotSuccessfullySubmitted"
private HtmlMessages
  valMessage
Initial: new HtmlMessages()
 
ViewItemFull Methods
Operation Details
public
acceptItem():String
Sequential
private
addHandleToMethod(
   HttpMethod method,
   String eSciDocUserHandle):void
Sequential
Notes: Adds a cookie named "escidocCookie" that holds the eScidoc user handle to the provided http method object.
@author Tobias Schraut
public
addToBasket():String
Sequential
Notes: public boolean getHasRevision() { return this.hasRevision; } public void setHasRevision(boolean hasRevision) { this.hasRevision = hasRevision; }
private
createAffiliatedOrganizationList():void
Sequential
Notes: Generates the affiliated organization list as one string for presenting it in the jsp via the dynamic html component. Doubled organizations will be detected and merged. All organizzations will be numbered.
private
createCreatorList():void
Sequential
Notes: Generates the creator list as list of formatted Strings.
@return String formatted creator list as string
public
createNewRevision():String
Sequential
Notes: Redirects the user to the create new revision page Changed by DiT, 29.11.2007: only show contexts when user has privileges for more than one context
@return Sring nav rule to load the create new revision page
public
deleteItem():String
Sequential
Notes: deletes the selected item(s) an redirects the user to the page he came from (depositor workspace or search result list)
@return String nav rule to load the page the user came from
public
editItem():String
Sequential
Notes: Redirects the user to the edit item page
@return Sring nav rule to load the edit item page
public
exportDownload():String
Sequential
Notes: Downloads the page with the selected items as export. This method is called when the user selects one or more items and then clicks on the Download-Button in the Export-Items Panel.
@author: StG
public
exportEmail():String
Sequential
Notes: Invokes the email service to send per email the the page with the selected items as attachment. This method is called when the user selects one or more items and then clicks on the EMail-Button in the Export-Items Panel.
@author: StG
public
getAbstractIterator():UIXIterator
Sequential
public
getAbstracts():ArrayList
Sequential
protected
getAcceptItemSessionBean():AcceptItemSessionBean
Sequential
Notes: Returns a reference to the scoped data bean (the AcceptItemSessionBean).
@return a reference to the scoped data bean
public
getAffiliatedOrganizationsList():List
Sequential
public
getAffiliations():String
Sequential
Notes: Gets the affiliation of the context the item belongs to.
@return String formatted context name
public
getAmountOfFiles():int
Sequential
Notes: Returns the total number of files in the item
@return int
public
getAmountOfLocators():int
Sequential
Notes: Returns the total number of locators in the item
@return int
protected
getApplicationBean():ApplicationBean
Sequential
Notes: Returns the ApplicationBean.
@return a reference to the scoped data bean (ApplicationBean)
public
getCitationURL():String
Sequential
protected
getCollectionListSessionBean():ContextListSessionBean
Sequential
Notes: Returns the ContextListSessionBean.
@return a reference to the scoped data bean (ContextListSessionBean)
public
getContext():ContextVO
Sequential
Notes: Returns the Context the item belongs to
public
getContextName():String
Sequential
Notes: Gets the name of the Collection the item belongs to.
@return String formatted Collection name
public
getCreatorAffiliationsIterator():UIXIterator
Sequential
public
getCreatorArray():ArrayList
Sequential
public
getCreatorOrganizationsArray():ArrayList
Sequential
public
getCreatorOrganizationsIterator():UIXIterator
Sequential
public
getCreatorPersonsIterator():UIXIterator
Sequential
public
getDates():String
Sequential
public
getDegreeType():String
Sequential
protected
getEditItemSessionBean():EditItemSessionBean
Sequential
Notes: Returns a reference to the scoped data bean (the EditItemSessionBean).
@return a reference to the scoped data bean
public
getEventAltTitleIterator():UIXIterator
Sequential
public static
getFacesParamValue(
   String name):String
Sequential
Notes: gets the parameters out of the faces context
@return the value of the parameter as string
public
getFileIterator():UIXIterator
Sequential
public
getFileList():List
Sequential
public
getFileSearchHitIterator():UIXIterator
Sequential
public
getFwUrl():String
Sequential
public
getGenre():String
Sequential
public
getHasAbstracts():boolean
Sequential
public
getHasAudience():boolean
Sequential
public
getIdentifiers():String
Sequential
Notes: Returns all Identifiers as formatted String
@return String the formatted Identifiers
public
getInvited():boolean
Sequential
Notes: Returns a true or a false according to the invited state of the item
@return boolean
public
getIsCreateNewRevisionDisabled():boolean
Sequential
public
getIsDepositor():boolean
Sequential
public
getIsFromEasySubmission():boolean
Sequential
public
getIsInBasket():boolean
Sequential
public
getIsLatestRelease():boolean
Sequential
public
getIsLatestVersion():boolean
Sequential
public
getIsLoggedIn():boolean
Sequential
public
getIsModerator():boolean
Sequential
public
getIsModifyDisabled():boolean
Sequential
public
getIsOwner():boolean
Sequential
public
getisPrivilegedViewer():boolean
Sequential <<property get>>
Tags: attribute_name=isPrivilegedViewer
public
getIsPublicStateReleased():boolean
Sequential
public
getIsStateInRevision():boolean
Sequential
public
getIsStatePending():boolean
Sequential
public
getIsStateReleased():boolean
Sequential
public
getIsStateSubmitted():boolean
Sequential
public
getIsStateWithdrawn():boolean
Sequential
public
getIsWorkflowSimple():boolean
Sequential
public
getIsWorkflowStandard():boolean
Sequential
protected
getItemControllerSessionBean():ItemControllerSessionBean
Sequential
Notes: Returns the ItemControllerSessionBean.
@return a reference to the scoped data bean (ItemControllerSessionBean)
public
getItemIsWithdrawn():boolean
Sequential
Notes: Returns a true or a false according to the state of the current item
@return boolean
protected
getItemListSessionBean():ItemListSessionBean
Sequential
Notes: Returns a reference to the scoped data bean (the ItemListSessionBean).
@return a reference to the scoped data bean
public
getItemPattern():String
Sequential
public
getItemPublicState():String
Sequential
public
getItemState():String
Sequential
protected
getItemVersionListSessionBean():ItemVersionListSessionBean
Sequential
Notes: Returns the ReleasesSessionBean.
@return a reference to the scoped data bean (ReleasesSessionBean)
public
getLanguagesIterator():UIXIterator
Sequential
public
getLinkForActionsView():String
Sequential
public
getLinkForExportView():String
Sequential
public
getLocatorIterator():UIXIterator
Sequential
public
getLocatorList():List
Sequential
public
getModeratorContactEmail():String
Sequential
Notes: This method returns the contact email address of the moderator strored in the item's context. If it is empty the pubman support address will be returned.
@return the moderator's email address (if available, otherwise pubman support address)
public
getModificationDate():String
Sequential
Notes: Returns the Modification date as formatted String (YYYY-MM-DD)
@return String the formatted date of modification
public
getOrganizationArray():ArrayList
Sequential
public
getOrganizationList():ArrayList
Sequential
public
getPanelItemFull():HtmlPanelGroup
Sequential
Notes: Getters and Setters
public
getPubItem():PubItemVO
Sequential
public
getPublishingInfo():String
Sequential
Notes: Returns the formatted Publishing Info according to filled elements
@return String the formatted Publishing Info
protected
getRelationListSessionBean():RelationListSessionBean
Sequential
Notes: Returns the RevisionListSessionBean.
@return a reference to the scoped data bean (RevisionListSessionBean)
protected
getReleaseHistory():ReleaseHistory
Sequential
Notes: Returns the ReleaseHistory.
@return a reference to the scoped data bean (RevisionListSessionBean)
public
getReviewMethod():String
Sequential
protected
getRightsManagementSessionBean():RightsManagementSessionBean
Sequential
Notes: Returns the RightsManagementSessionBean.
@author DiT
@return a reference to the scoped data bean (RightsManagementSessionBean)
protected
getSearchResultListSessionBean():SearchResultListSessionBean
Sequential
Notes: Returns the SearchResultListSessionBean.
@return a reference to the scoped data bean (SearchResultListSessionBean)
protected
getSessionBean():CommonSessionBean
Sequential
Notes: Returns the CommonSessionBean.
@return a reference to the scoped data bean (CommonSessionBean)
public
getShowCiteItem():boolean
Sequential
Notes: Returns a boolean according to the user item state
@author Markus Haarlaender
@return boolean
public
getShowDates():boolean
Sequential
Notes: Returns false if all dates are empty
@author Markus Haarlaender
@return boolean
public
getShowDetails():boolean
Sequential
Notes: Returns a true or a false according top the existance of specified fields in the details section
@return boolean
public
getShowEvents():boolean
Sequential
Notes: Returns a true or a false according to the existance of an event in the item
@return boolean
public
getShowFiles():boolean
Sequential
Notes: Returns a true or a false according to the existance of files in the item
@return boolean
public
getShowLocators():boolean
Sequential
Notes: Returns a true or a false according to the existance of locators in the item
@return boolean
public
getShowSources():boolean
Sequential
Notes: Returns a true or a false according to the existance of sources in the item
@return boolean
public
getShowSystemDetails():boolean
Sequential
Notes: Returns a true or a false according to the user state (logged in or not)
@author Markus Haarlaender
@return boolean
public
getSourceCreatorAffiliationsIterator():UIXIterator
Sequential
public
getSourceCreatorOrganizationsIterator():UIXIterator
Sequential
public
getSourceCreatorPersonsIterator():UIXIterator
Sequential
public
getSourceIterator():UIXIterator
Sequential
public
getSourceList():List
Sequential
public
getSourceTitleIterator():UIXIterator
Sequential
public
getStartEndDate():String
Sequential
Notes: Returns a formatted String including the start and the end date of the event
@return String the formatted date string
public
getSubjectIterator():UIXIterator
Sequential
protected
getSubmitItemSessionBean():SubmitItemSessionBean
Sequential
Notes: Returns a reference to the scoped data bean (the SubmitItemSessionBean).
@return a reference to the scoped data bean
public
getTitleIterator():UIXIterator
Sequential
public
getUnapiApa():String
Sequential
public
getUnapiBibtex():String
Sequential
public
getUnapiEndnote():String
Sequential
public
getUnapiEscidoc():String
Sequential
public
getUnapiURLdownload():String
Sequential
public
getUnapiURLview():String
Sequential
public
getValMessage():HtmlMessages
Sequential
protected
getViewItemSessionBean():ViewItemSessionBean
Sequential
Notes: Returns the ViewItemSessionBean.
@return a reference to the scoped data bean (ViewItemSessionBean)
public
getWithdrawalDate():String
Sequential
Notes: Returns the formatted withdrawal date as string
@return String formatted withdrawal date
protected
getWithdrawItemSessionBean():WithdrawItemSessionBean
Sequential
Notes: Returns a reference to the scoped data bean (the ViewItemSessionBean).
@return a reference to the scoped data bean
public
init():void
Sequential
Notes: Callback method that is called whenever a page containing this page fragment is navigated to, either directly via a URL, or indirectly via page navigation. Changed by DiT, 15.10.2007: added link for modify
public
modifyItem():String
Sequential
Notes: Redirects the user to the edit item page in modify-mode
@return Sring nav rule to load the editItem item page
public
removeFromBasket():String
Sequential
public
reviseItem():String
Sequential
public
setAbstractIterator(
   UIXIterator abstractIterator):void
Sequential
public
setAffiliatedOrganizationsList(
   List affiliatedOrganizationsList):void
Sequential
public
setCitationURL(
   String citationURL):void
Sequential
public
setCreateNewRevisionDisabled(
   boolean isCreateNewRevisionDisabled):void
Sequential
public
setCreatorAffiliationsIterator(
   UIXIterator creatorAffiliationsIterator):void
Sequential
public
setCreatorArray(
   ArrayList creatorArray):void
Sequential
public
setCreatorOrganizationsArray(
   ArrayList creatorOrganizationsArray):void
Sequential
public
setCreatorOrganizationsIterator(
   UIXIterator creatorOrganizationsIterator):void
Sequential
public
setCreatorPersonsIterator(
   UIXIterator creatorPersonsIterator):void
Sequential
public
setDepositor(
   boolean isDepositor):void
Sequential
public
setEventAltTitleIterator(
   UIXIterator eventAltTitleIterator):void
Sequential
public
setFileIterator(
   UIXIterator fileIterator):void
Sequential
public
setFileList(
   List fileList):void
Sequential
public
setFileSearchHitIterator(
   UIXIterator fileSearchHitIterator):void
Sequential
public
setFwUrl(
   String fwUrl):void
Sequential
public
setItemPattern(
   String itemPattern):void
Sequential
public
setLanguagesIterator(
   UIXIterator languagesIterator):void
Sequential
public
setLatestRelease(
   boolean isLatestRelease):void
Sequential
public
setLatestVersion(
   boolean isLatestVersion):void
Sequential
public
setLocatorIterator(
   UIXIterator locatorIterator):void
Sequential
public
setLocatorList(
   List locatorList):void
Sequential
public
setLoggedIn(
   boolean isLoggedIn):void
Sequential
public
setModerator(
   boolean isModerator):void
Sequential
public
setModifyDisabled(
   boolean isModifyDisabled):void
Sequential
public
setOrganizationArray(
   ArrayList organizationArray):void
Sequential
public
setOrganizationList(
   ArrayList organizationList):void
Sequential
public
setOwner(
   boolean isOwner):void
Sequential
public
setPanelItemFull(
   HtmlPanelGroup panelItemFull):void
Sequential
public
setPrivilegedViewer(
   boolean isPrivilegedViewer):void
Sequential
public
setPubItem(
   PubItemVOPresentation pubItem):void
Sequential
public
setPublicStateReleased(
   boolean isPublicStateReleased):void
Sequential
public
setSourceCreatorAffiliationsIterator(
   UIXIterator sourceCreatorAffiliationsIterator):void
Sequential
public
setSourceCreatorOrganizationsIterator(
   UIXIterator sourceCreatorOrganizationsIterator):void
Sequential
public
setSourceCreatorPersonsIterator(
   UIXIterator sourceCreatorPersonsIterator):void
Sequential
public
setSourceIterator(
   UIXIterator sourceIterator):void
Sequential
public
setSourceList(
   List sourceList):void
Sequential
public
setSourceTitleIterator(
   UIXIterator sourceTitleIterator):void
Sequential
public
setStateInRevision(
   boolean isStateInRevision):void
Sequential
public
setStatePending(
   boolean isStatePending):void
Sequential
public
setStateReleased(
   boolean isStateReleased):void
Sequential
public
setStateSubmitted(
   boolean isStateSubmitted):void
Sequential
public
setStateWithdrawn(
   boolean isStateWithdrawn):void
Sequential
public
setSubjectIterator(
   UIXIterator subjectIterator):void
Sequential
public
setTitleIterator(
   UIXIterator titleIterator):void
Sequential
public
setUnapiApa(
   String unapiApa):void
Sequential
public
setUnapiBibtex(
   String unapiBibtex):void
Sequential
public
setUnapiEndnote(
   String unapiEndnote):void
Sequential
public
setUnapiEscidoc(
   String unapiEscidoc):void
Sequential
public
setUnapiURLdownload(
   String unapiURLdownload):void
Sequential
public
setUnapiURLview(
   String unapiURLview):void
Sequential
public
setValMessage(
   HtmlMessages valMessage):void
Sequential
public
setWorkflowSimple(
   boolean isWorkflowSimple):void
Sequential
public
setWorkflowStandard(
   boolean isWorkflowStandard):void
Sequential
public
showItemLog():String
Sequential
Notes: Redirects the user to the Item Log page.
@return String nav rule to load the create new revision page.
public
showReleaseHistory():String
Sequential
Notes: Navigates to the release history page.
@return the faces navigation string
public
showRevisions():String
Sequential
Notes: Redirects the user to the View revisions page.
@return Sring nav rule to load the create new revision page.
public
showStatistics():String
Sequential
Notes: Redirects the user to the statistics page.
@return String nav rule to load the create new revision page.
private
showValidationMessages(
   ValidationReportVO report):void
Sequential
Notes: Displays validation messages.
@author Michael Franke
public
submitItem():String
Sequential
Notes: submits the selected item(s) an redirects the user to the page he came from (depositor workspace or search result list) Changed by FrM: Inserted validation and call to "enter submission comment" page.
@return String nav rule to load the page the user came from
public
ViewItemFull():
Sequential
Notes: Public constructor.
public
withdrawItem():String
Sequential
Notes: Redirects the user to the withdraw item page
@return Sring nav rule to load the withdraw item page