Represents the Icat entities as described in the Icat schema documentation where it describes the attributes for each IcatEntity.
- Source:
Members
datasetCount :number
The total number of datasets for this investigation. Only applies to investigations and only gets set after calling
getDatasetCount().
Type:
- number
- Source:
datasetCount :number
total number of datafiles for this investigation or dataset. Only applies to investigations or datasets, and only gets set after calling
getDatfileCount().
Type:
- number
- Source:
entityType :string
The type of entity e.g. 'investigation', 'facility' or 'facilityCycle' etc...
Type:
- string
- Source:
size :number
total size of an investigation or dataset. Only applies to investigations and datasets, and only gets set after calling
getSize().
Type:
- number
- Source:
Methods
addToCart(options) → {Promise.<Cart>}
Adds this entity to the Cart and returns the updated Cart. Only applies to investigations, datasets or datafiles.
Parameters:
| Name | Type | Description |
|---|---|---|
options |
object | as specified in the Angular documentation |
- Source:
Returns:
the updated cart
addToCart(timeout) → {Promise.<Cart>}
Adds this entity to the Cart and returns the updated Cart. Only applies to investigations, datasets or datafiles.
Parameters:
| Name | Type | Description |
|---|---|---|
timeout |
Promise | if resolved will cancel the request |
- Source:
Returns:
the updated cart
addToCart() → {Promise.<Cart>}
Adds this entity to the Cart and returns the updated Cart. Only applies to investigations, datasets or datafiles.
- Source:
Returns:
the updated cart
addToCart(timeout) → {Promise.<Cart>}
Deletes this entity from the Cart and returns the updated Cart. Only applies to investigations, datasets or datafiles.
Parameters:
| Name | Type | Description |
|---|---|---|
timeout |
Promise | if resolved will cancel the request |
- Source:
Returns:
the updated cart
addToCart() → {Promise.<Cart>}
Deletes this entity from the Cart and returns the updated Cart. Only applies to investigations, datasets or datafiles.
- Source:
Returns:
the updated cart
browse()
Redirects the user the to the relevant position in the "Browse" hierarchy.
- Source:
deleteFromCart(options) → {Promise.<Cart>}
Deletes this entity from the Cart and returns the updated Cart. Only applies to investigations, datasets or datafiles.
Parameters:
| Name | Type | Description |
|---|---|---|
options |
object | as specified in the Angular documentation |
- Source:
Returns:
the updated cart
getDatafileCount(options) → {Promise.<number>}
Returns the total number of datafiles for this investigation or dataset. Only applies to investigations or datasets.
Parameters:
| Name | Type | Description |
|---|---|---|
options |
object | as specified in the Angular documentation |
- Source:
Returns:
the deferred number of datafiles in this investigation or dataset
- Type
- Promise.<number>
getDatafileCount(timeout) → {Promise.<number>}
Returns the total number of datafiles for this investigation or dataset. Only applies to investigations or datasets.
Parameters:
| Name | Type | Description |
|---|---|---|
timeout |
Promise | if resolved will cancel the request |
- Source:
Returns:
the deferred number of datafiles in this investigation or dataset
- Type
- Promise.<number>
getDatafileCount() → {Promise.<number>}
Returns the total number of datafiles for this investigation or dataset. Only applies to investigations or datasets.
- Source:
Returns:
the deferred number of datafiles in this investigation or dataset
- Type
- Promise.<number>
getDatasetCount(options) → {Promise.<number>}
Returns the total number of datasets for this investigation. Only applies to investigations.
Parameters:
| Name | Type | Description |
|---|---|---|
options |
object | as specified in the Angular documentation |
- Source:
Returns:
the deferred number of datasets in this investigation
- Type
- Promise.<number>
getDatasetCount(timeout) → {Promise.<number>}
Returns the total number of datasets for this investigation. Only applies to investigations.
Parameters:
| Name | Type | Description |
|---|---|---|
timeout |
Promise | if resolved will cancel the request |
- Source:
Returns:
the deferred number of datasets in this investigation
- Type
- Promise.<number>
getDatasetCount() → {Promise.<number>}
Returns the total number of datasets for this investigation. Only applies to investigations.
- Source:
Returns:
the deferred number of datasets in this investigation
- Type
- Promise.<number>
getSize(options) → {Promise.<number>}
Returns the total size of an investigation or dataset. Only applies to investigations and datasets.
Parameters:
| Name | Type | Description |
|---|---|---|
options |
object | as specified in the Angular documentation |
- Source:
Returns:
the deferred total size of this investigation or dataset
- Type
- Promise.<number>
getSize(timeout) → {Promise.<number>}
Returns the total size of an investigation or dataset. Only applies to investigations and datasets.
Parameters:
| Name | Type | Description |
|---|---|---|
timeout |
Promise | if resolved will cancel the request |
- Source:
Returns:
the deferred total size of this investigation or dataset
- Type
- Promise.<number>
getSize() → {Promise.<number>}
Returns the total size of an investigation or dataset. Only applies to investigations and datasets.
- Source:
Returns:
the deferred total size of this investigation or dataset
- Type
- Promise.<number>
getStatus(options) → {Promise.<string>}
Returns whether or not this investigation, dataset or datafile is available or not. Only applies to investigations, datasets or datafiles on a two tier IDS.
Parameters:
| Name | Type | Description |
|---|---|---|
options |
object | as specified in the Angular documentation |
- Source:
Returns:
the deferred availability of this investigation, dataset or datafile. Can be either 'ONLINE', 'ARCHIVE' or 'RESTORING'
- Type
- Promise.<string>
getStatus(timeout) → {Promise.<string>}
Returns whether or not this investigation, dataset or datafile is available or not. Only applies to investigations, datasets or datafiles on a two tier IDS.
Parameters:
| Name | Type | Description |
|---|---|---|
timeout |
Promise | if resolved will cancel the request |
- Source:
Returns:
the deferred availability of this investigation, dataset or datafile. Can be either 'ONLINE', 'ARCHIVE' or 'RESTORING'
- Type
- Promise.<string>
getStatus() → {Promise.<string>}
Returns whether or not this investigation, dataset or datafile is available or not. Only applies to investigations, datasets or datafiles on a two tier IDS.
- Source:
Returns:
the deferred availability of this investigation, dataset or datafile. Can be either 'ONLINE', 'ARCHIVE' or 'RESTORING'
- Type
- Promise.<string>