| Package | com.adobe.idp.taskmanager.dsc.client.task |
| Interface | public interface AttachmentInfo |
Use the setType() method to specify the type of attachment. The default value is TYPE_ATTACHMENT.
See also
| Method | Defined by | ||
|---|---|---|---|
|
Date getCreateDate()
Retrieves the time stamp indicating when this attachment was created.
| AttachmentInfo | ||
|
String getCreatorCommonName()
Retrieves the common name of the user who created this attachment.
| AttachmentInfo | ||
|
String getCreatorId()
Retrieves the identifier of the user who created this attachment.
| AttachmentInfo | ||
|
String getDescription()
Retrieves the description for this attachment.
| AttachmentInfo | ||
|
String getFileName()
Retrieves the file name for this attachment.
| AttachmentInfo | ||
|
long getId()
Retrieves the identifier for this attachment.
| AttachmentInfo | ||
|
Date getLastModifiedDate()
Retrieves the time stamp indicating when this attachment was last updated.
| AttachmentInfo | ||
|
int getPermissions()
Retrieves the permissions for this attachment.
| AttachmentInfo | ||
|
long getSize()
Returns the file size, in bytes, of this attachment.
| AttachmentInfo | ||
|
String getType()
Retrieves the type of the attachment.
| AttachmentInfo | ||
|
boolean isDeleteable()
Determines whether this attachment can be deleted.
| AttachmentInfo | ||
|
boolean isNoteExtended()
Determines whether a note attachment is longer than the contents of the description field.
| AttachmentInfo | ||
|
boolean isReadable()
Determines whether this attachment is readable.
| AttachmentInfo | ||
|
boolean isWriteable()
Determines whether this attachment is writeable.
| AttachmentInfo | ||
|
void setDescription(String aDescription)
Sets the description for a new attachment.
| AttachmentInfo | ||
|
void setFileName(String aFileName)
Sets the file name for this attachment.
| AttachmentInfo | ||
|
void setId(long aId)
Sets the identifier for this attachment.
| AttachmentInfo | ||
|
void setPermissions(int aPermissions)
Sets new permissions for this attachment.
| AttachmentInfo | ||
|
void setType(String attachmentType)
Sets the type of the attachment.
| AttachmentInfo | ||
| Constant | Defined by | ||
|---|---|---|---|
| ATTACH_CREATE_DATE
[static] Document attribute that contains the attachment creation date when a list of documents is exported from the task.
| AttachmentInfo | ||
| ATTACH_CREATOR_ID
[static] Document attribute that contains the attachment creator identifier when a list of documents is exported from the task.
| AttachmentInfo | ||
| ATTACH_DESC
[static] Document attribute that contains the attachment description (or note content) when a list of documents is exported from the task.
| AttachmentInfo | ||
| ATTACH_FILENAME
[static] Document attribute that contains the attachment file name when a list of documents is exported from the task.
| AttachmentInfo | ||
| ATTACH_PERM
[static] Document attribute that contains the attachment permissions when a list of documents is exported from the task.
| AttachmentInfo | ||
| ATTACH_TYPE
[static] Document attribute that contains the attachment type when a list of documents is exported from the task.
| AttachmentInfo | ||
| ATTACH_UPDATE_DATE
[static] Document attribute that contains the attachment update date when a list of documents is exported from the task.
| AttachmentInfo | ||
| PERMISSION_DELETE
[static] A bit mask value containing the delete permission for the attachment.
| AttachmentInfo | ||
| PERMISSION_READ
[static] A bit mask value containing the read permission for the attachment.
| AttachmentInfo | ||
| PERMISSION_WRITE
[static] A bit mask value containing the permission for writing the attachment.
| AttachmentInfo | ||
| TYPE_ATTACHMENT
[static] Indicates that this attachment is of an attachment type.
| AttachmentInfo | ||
| TYPE_NOTE
[static] Indicates this attachment is a note type.
| AttachmentInfo | ||
| getCreateDate | () |
public Date getCreateDate()Retrieves the time stamp indicating when this attachment was created.
Returns| getCreatorCommonName | () |
public String getCreatorCommonName()Retrieves the common name of the user who created this attachment. The creator of an attachment is permitted to modify an attachment or remove it, regardless of attachment permissions.
ReturnsUnknownValueException |
| getCreatorId | () |
public String getCreatorId()Retrieves the identifier of the user who created this attachment. The owner of an attachment is permitted to modify an attachment or remove it, regardless of attachment permissions.
ReturnsUnknownValueException |
| getDescription | () |
public String getDescription()Retrieves the description for this attachment.
Returns| The description for this attachment. |
UnknownValueException |
| getFileName | () |
public String getFileName()Retrieves the file name for this attachment.
ReturnsUnknownValueException — if the name has not been set. |
| getId | () |
public long getId()Retrieves the identifier for this attachment.
Returns| This attachment's identifier. |
UnknownValueException — if the identifier has not been set. |
| getLastModifiedDate | () |
public Date getLastModifiedDate()Retrieves the time stamp indicating when this attachment was last updated.
ReturnsUnknownValueException — if the last modified date is not known. |
| getPermissions | () |
public int getPermissions()Retrieves the permissions for this attachment. Permissions are a bit mask made up of the PERMISSION_READ, PERMISSION_WRITE, and PERMISSION_DELETE values.
Returns| The permissions for this object. |
UnknownValueException — if the permissions for this attachment are unknown. |
| getSize | () |
public long getSize()Returns the file size, in bytes, of this attachment.
ReturnsUnknownValueException — if the file size is not known. |
| getType | () |
public String getType()Retrieves the type of the attachment. The possible values are TYPE_ATTACHMENT and TYPE_NOTE.
ReturnsA String indicating the type of the attachment (attachment or note). |
| isDeleteable | () |
public boolean isDeleteable()Determines whether this attachment can be deleted.
Returnstrue if this attachment can be deleted, false otherwise. |
UnknownValueException — if the permissions of this attachment are unknown. |
| isNoteExtended | () |
public boolean isNoteExtended()Determines whether a note attachment is longer than the contents of the description field.
If true, only a part of the note can be viewed from the description field, and the full note contents can only be seen by returning the note contents.
true if the note attachment of type note is longer than the description field, false otherwise. |
| isReadable | () |
public boolean isReadable()Determines whether this attachment is readable.
Returnstrue if this attachment can be read, false otherwise. |
UnknownValueException — if the permissions of this attachment are unknown. |
| isWriteable | () |
public boolean isWriteable()Determines whether this attachment is writeable.
Returnstrue if this attachment can be updated, false otherwise. |
UnknownValueException — if the permissions of this attachment are unknown. |
| setDescription | () |
public void setDescription(String aDescription)Sets the description for a new attachment. The description appears in the user interface.
Parameters
aDescription — The description for the attachment. |
UnknownValueException |
| setFileName | () |
public void setFileName(String aFileName)Sets the file name for this attachment.
Parameters
aFileName — The file name for this attachment. |
| setId | () |
public void setId(long aId)Sets the identifier for this attachment.
Parameters
aId — The identifier for this attachment. |
| setPermissions | () |
public void setPermissions(int aPermissions)Sets new permissions for this attachment.
aPermissions is a bit mask made up of PERMISSION_READ (001), PERMISSION_WRITE (010), and PERMISSION_DELETE values (100). Therefore, read and write permissions would correspond to a value of 011; read, write, and delete permissions would correspond to a value of 111.
Parameters
aPermissions — The new permissions for this attachment. |
| setType | () |
public void setType(String attachmentType)Sets the type of the attachment. The possible values are TYPE_ATTACHMENT and TYPE_NOTE.
Parameters
attachmentType — The type of attachment. |
UnknownValueException — if the type being set does not match one of the possible values. |
| ATTACH_CREATE_DATE | Constant |
public static final ATTACH_CREATE_DATEDocument attribute that contains the attachment creation date when a list of documents is exported from the task.
| ATTACH_CREATOR_ID | Constant |
public static final ATTACH_CREATOR_IDDocument attribute that contains the attachment creator identifier when a list of documents is exported from the task.
| ATTACH_DESC | Constant |
public static final ATTACH_DESCDocument attribute that contains the attachment description (or note content) when a list of documents is exported from the task.
| ATTACH_FILENAME | Constant |
public static final ATTACH_FILENAMEDocument attribute that contains the attachment file name when a list of documents is exported from the task.
| ATTACH_PERM | Constant |
public static final ATTACH_PERMDocument attribute that contains the attachment permissions when a list of documents is exported from the task.
| ATTACH_TYPE | Constant |
public static final ATTACH_TYPEDocument attribute that contains the attachment type when a list of documents is exported from the task.
Its possible values are TYPE_ATTACHMENT and TYPE_NOTE.
| ATTACH_UPDATE_DATE | Constant |
public static final ATTACH_UPDATE_DATEDocument attribute that contains the attachment update date when a list of documents is exported from the task.
| PERMISSION_DELETE | Constant |
public static final PERMISSION_DELETEA bit mask value containing the delete permission for the attachment.
| PERMISSION_READ | Constant |
public static final PERMISSION_READA bit mask value containing the read permission for the attachment.
| PERMISSION_WRITE | Constant |
public static final PERMISSION_WRITEA bit mask value containing the permission for writing the attachment.
| TYPE_ATTACHMENT | Constant |
public static final TYPE_ATTACHMENTIndicates that this attachment is of an attachment type.
| TYPE_NOTE | Constant |
public static final TYPE_NOTEIndicates this attachment is a note type. Notes are text value attachments, and do not have content.
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/programmer/javadoc/com/adobe/idp/taskmanager/dsc/client/task/AttachmentInfo.html