Package org.dspace.app.rest.model

Class RequestItemRest

java.lang.Object
org.dspace.app.rest.model.RestAddressableModel
org.dspace.app.rest.model.BaseObjectRest<Integer>
org.dspace.app.rest.model.RequestItemRest
All Implemented Interfaces:
Serializable, RestModel
@LinkRest(name="bitstream",method="getUuid") @LinkRest(name="item",method="getUuid") public class RequestItemRest extends BaseObjectRest<Integer>
Represent a user's request for a copy of an Item.
Author:
Mark H. Wood <mwood@iupui.edu>
See Also:

  • Field Details

    • NAME

      public static final String NAME
      See Also:

    • PLURAL_NAME

      public static final String PLURAL_NAME
      See Also:

    • CATEGORY

      public static final String CATEGORY
      See Also:

    • bitstream_id

      protected String bitstream_id

    • decisionDate

      protected Instant decisionDate

    • expires

      protected Instant expires

    • item_id

      protected String item_id

    • reqEmail

      protected String reqEmail

    • reqMessage

      protected String reqMessage

    • reqName

      protected String reqName

    • requestDate

      protected Instant requestDate

    • token

      protected String token

    • acceptRequest

      protected boolean acceptRequest

    • allfiles

      protected boolean allfiles

    • accessToken

      protected String accessToken

    • accessExpiry

      protected Instant accessExpiry

    • accessExpired

      protected boolean accessExpired

  • Constructor Details

    • RequestItemRest

      public RequestItemRest()

  • Method Details

    • getBitstreamId

      public String getBitstreamId()
      Returns:
      the bitstream requested.

    • setBitstreamId

      public void setBitstreamId(String bitstream_id)
      Parameters:
      bitstream_id - the bitstream requested.

    • getDecisionDate

      public Instant getDecisionDate()
      Returns:
      the decisionDate

    • setDecisionDate

      public void setDecisionDate(Instant decided)
      Parameters:
      decided - the decisionDate to set

    • getExpires

      public Instant getExpires()
      Returns:
      the expires

    • setExpires

      public void setExpires(Instant expires)
      Parameters:
      expires - the expires to set

    • getItemId

      public String getItemId()
      Returns:
      the item requested.

    • setItemId

      public void setItemId(String item_id)
      Parameters:
      item_id - the item requested.

    • getRequestEmail

      public String getRequestEmail()
      Returns:
      the email address of the requester.

    • setRequestEmail

      public void setRequestEmail(String email)
      Parameters:
      email - the email address of the requester.

    • getRequestMessage

      public String getRequestMessage()
      Returns:
      the requester's message.

    • setRequestMessage

      public void setRequestMessage(String message)
      Parameters:
      message - the requester's message.

    • getRequestName

      public String getRequestName()
      Returns:
      the requester's name.

    • setRequestName

      public void setRequestName(String name)
      Parameters:
      name - the requester's name.

    • getRequestDate

      public Instant getRequestDate()
      Returns:
      the requestDate

    • setRequestDate

      public void setRequestDate(Instant requested)
      Parameters:
      requested - the requestDate to set

    • getToken

      public String getToken()
      Returns:
      the token which identifies this request.

    • setToken

      public void setToken(String token)
      Parameters:
      token - the token which identifies this request.

    • isAcceptRequest

      public boolean isAcceptRequest()
      Returns:
      true if the request has been accepted.

    • setAcceptRequest

      public void setAcceptRequest(boolean accepted)
      Parameters:
      accepted - true if the request has been accepted.

    • isAllfiles

      public boolean isAllfiles()
      Returns:
      true if the request is for all files in the item.

    • setAllfiles

      public void setAllfiles(boolean allfiles)
      Parameters:
      allfiles - true requesting all of the item's files.

    • getAccessToken

      public String getAccessToken()
      Returns:
      the unique access token to be used by the requester. This is separate to the approval token ('token')

    • setAccessToken

      public void setAccessToken(String accessToken)
      Parameters:
      accessToken - the access token to be used by the requester (not settable through JSON update)

    • getAccessExpiry

      public Instant getAccessExpiry()
      Returns:
      the date the access token expires.

    • setAccessExpiry

      public void setAccessExpiry(Instant accessExpiry)
      Parameters:
      accessExpiry - the date the access token expires.

    • isAccessExpired

      public boolean isAccessExpired()

    • setAccessExpired

      public void setAccessExpired(boolean accessExpired)

    • getCategory

      public String getCategory()
      Specified by:
      getCategory in class RestAddressableModel

    • getController

      public Class getController()
      Specified by:
      getController in class RestAddressableModel

    • getType

      public String getType()

    • getTypePlural

      public String getTypePlural()