Add(IPublishReportItem item)
Add the specified report item to the list
-
item
-
IPublishReportItem with the report item that must be added to the list
|
GetItem
Gets a report item with the given ishRef. If the ishRef refers to an image the preferred resolution is returned.
Note: If the item is not present in the list, an exception is thrown!
Note: This method only returns the items with PublishItemMode PrimaryItem.
-
ishRef
-
String with the logical identifier of the report item.
|
GetItem
Gets a report item with the given ishRef in the given resolution.
Note: If the item is not present in the list, an exception is thrown!
Note: This method only returns the items with PublishItemMode PrimaryItem.
-
ishRef
-
String with the logical identifier of the report item.
-
resolution
-
String with the resolution
|
GetItem
Gets a report item with the given ishRef and the given PublishItemMode.
Note: If the item is not present in the list, an exception is thrown!
-
ishRef
-
String with the logical identifier of the report item.
-
publishItemMode
-
The PublishItemMode.
Note: The possible values are: PrimaryItem or ExtraCompareItem. In most situations the value will be PrimaryItem, only in case the reference is to an image of which the version was changed between 2 compared publication outputs (so in the compare folder you will have 2 files with the same GUID and resolution(e.g. GUID-X.v2-low.jpg and GUID-X.v1-low.jpg)) the reference to the latter will be marked as ExtraCompareItem.
|
GetItem
Gets a report item with the given ishRef in the given resolution and the given PublishItemMode
Note: If the item is not present in the list, an exception is thrown!
-
ishRef
-
String with the logical identifier of the report item.
-
resolution
-
String with the resolution
-
publishItemMode
-
The PublishItemMode.
Note: The possible values are: PrimaryItem or ExtraCompareItem. In most situations the value will be PrimaryItem, only in case the reference is to an image of which the version was changed between 2 compared publication outputs (so in the compare folder you will have 2 files with the same GUID and resolution(e.g. GUID-X.v2-low.jpg and GUID-X.v1-low.jpg)) the reference to the latter will be marked as ExtraCompareItem.
|
TryGetItem
Tries to get a report item with the given ishRef. If the ishRef refers to an image the preferred resolution is returned.
Note: If the key is not present in the list, the value is null.
Note: This method only returns the items with PublishItemMode PrimaryItem.
-
ishRef
-
String with the logical identifier of the report item.
|
TryGetItem
Tries to get a report item with the given ishRef and resolution.
Note: If the key is not present in the list, the value is null.
Note: This method only returns the items with PublishItemMode PrimaryItem.
-
ishRef
-
String with the logical identifier of the report item.
-
resolution
-
String with the resolution
|
TryGetItem
Tries to get a report item with the given ishRef and PublishItemMode.
Note: If the key is not present in the list, the value is null.
-
ishRef
-
String with the logical identifier of the report item.
-
publishItemMode
-
The PublishItemMode.
Note: The possible values are: PrimaryItem or ExtraCompareItem. In most situations the value will be PrimaryItem, only in case the reference is to an image of which the version was changed between 2 compared publication outputs (so in the compare folder you will have 2 files with the same GUID and resolution(e.g. GUID-X.v2-low.jpg and GUID-X.v1-low.jpg)) the reference to the latter will be marked as ExtraCompareItem.
|
TryGetItem
Tries to get a report item with the given ishRef in the given resolution and the given PublishItemMode.
Note: If the key is not present in the list, the value is null.
-
ishRef
-
String with the logical identifier of the report item.
-
resolution
-
String with the resolution
-
publishItemMode
-
The PublishItemMode.
Note: The possible values are: PrimaryItem or ExtraCompareItem. In most situations the value will be PrimaryItem, only in case the reference is to an image of which the version was changed between 2 compared publication outputs (so in the compare folder you will have 2 files with the same GUID and resolution(e.g. GUID-X.v2-low.jpg and GUID-X.v1-low.jpg)) the reference to the latter will be marked as ExtraCompareItem.
|
ListAll Gets a list with all report items.
Note: This method returns the items with PublishItemMode PrimaryItem and ExtraCompareItem
|
List
Gets a list with the report items having a certain PublishItemMode.
-
publishItemMode
-
The
PublishItemMode for which to get the report items.
Note: The possible values are: PrimaryItem or ExtraCompareItem. In most situations the value will be PrimaryItem, only in case the reference is to an image of which the version was changed between 2 compared publication outputs (so in the compare folder you will have 2 files with the same GUID and resolution(e.g. GUID-X.v2-low.jpg and GUID-X.v1-low.jpg)) the reference to the latter will be marked as ExtraCompareItem.
|