Micro Focus Content Manager SDK 9.4
HP.HPTRIM.SDK.Space Class Reference

Represents a location for long term archival storage of physical records, typically within a warehouse More...

Inheritance diagram for HP.HPTRIM.SDK.Space:
HP.HPTRIM.SDK.TrimMainObject HP.HPTRIM.SDK.ITrimUserFields HP.HPTRIM.SDK.ITrimSecurity HP.HPTRIM.SDK.ITrimAccessControl HP.HPTRIM.SDK.ITrimLabels HP.HPTRIM.SDK.TrimObject HP.HPTRIM.SDK.TrimPropertySet

Public Member Functions

 Space (Database database, TrimURI uri)
 
 Space (Database database, string name)
 
 Space (Database database)
 
TrimMainObjectSearch CreateLowerLevels (int nbrOfSpacesToCreate, int capacityOfEachSpace, int startNumberingFrom, int createAtLevel)
 
UserFieldValue GetFieldValue (FieldDefinition userFieldType)
 Gets the value of the nominated user-defined field for this object. More...
 
void SetFieldValue (FieldDefinition userFieldType, UserFieldValue newValue)
 Sets the value of the nominated user-defined field for this object. More...
 
string GetFieldValueAsString (FieldDefinition userFieldType, StringDisplayType fieldValueStringType, bool useHTMLEscapeChars)
 Gets a string representation of a user-defined field value in a format appropriate for a specific use. More...
 
void ApplyUserLabel (UserLabel userLabelToApply)
 Creates a link between the nominated user label and this object. More...
 
void DetachUserLabel (UserLabel userLabelToDetach)
 Removes the link between the nominated user label and this object. More...
 
void AddToFavorites ()
 Adds the object to the special user label called 'Favorites' More...
 
void RemoveFromFavorites ()
 Removes the object from the special user label called 'Favorites' More...
 
bool ChangePositionWithinFavorites (LabelPositionChange positionChange)
 Changes the position of this object within a users list of favorite objects of this type More...
 
bool ChangePositionWithinUserLabel (UserLabel label, LabelPositionChange positionChange)
 Changes the position of this object within a users list of objects that have been labeled with the specified user label More...
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimMainObject
virtual void Save ()
 Permanently commits all changes made to this object (and all its child objects). For new objects a new unique identifier will be allocated (Uri). More...
 
string MakeReference (string SuggestName)
 Creates a TRIM reference file for this object, given the path and filename. A reference file can be associated with the Open command of various of the TRIM executables - TRIM.exe, TRIMDesktop.exe, etc. When the reference file is double-clicked, the associated application will then launch (or activate if it already running) and the object will then be displayed inside that executable. Returns a string containing the path and filename of the reference file created. More...
 
virtual void Delete ()
 Permanently removes this object and all its associated child objects from the database. More...
 
bool IsDeleteOk ()
 Determines if this object can be deleted. If it returns false, check the ErrorMessage details for more information. It is possible that the ErrorMessage property could contain a warning message even though the function returns true. More...
 
bool Verify (bool failOnWarning)
 Verifies all properties that have been modified since this object was last saved. Returns a Boolean value indicating whether the function succeeded. If false, the error description is stored in the ErrorMessage property. More...
 
TrimChildObjectList GetChildObjectList (BaseObjectTypes childType)
 Retrieves the child object collection of the nominated child object type. More...
 
TrimMainObject GetNewCopy ()
 Creates a new TrimMainObject which is a copy of this TrimMainObject. Where appropriate, property values are copied from this TrimMainObject to the new TrimMainObject. You will generally need to set any unique properties manually afterwards, prior to committing this new TrimMainObject to the TRIM database with the Save() method. See also the NewCopy function of the derived objects that implement this capability. Will return NULL if this object does not support the Copy function. More...
 
virtual void Refresh ()
 Resets this object to the current state on the database, will revert any changes that might have been made. Only required if you are not using BOBnotifications, or need to guarantee a really up-to-date version of the object state. More...
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimObject
bool IsMandatory (FieldDefinition field)
 Gets a boolean value indication whether the specified field must have a non-NULL value for this object. More...
 
bool IsValidFor (int purpose)
 Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. More...
 
bool IsValidFor (int purpose, TrimMainObject purposeExtraObject)
 Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraObject is necessary for some purpose types - once again, the derived class will have more information. More...
 
bool IsValidFor (int purpose, int purposeExtraEnumValue)
 Call this method to determine if this object can be used for the nominated purpose. To determine what the valid purposes are, look in the derived class at the more type safe versions of this function. The purposeExtraInformation is necessary for some purpose types - once again, the derived class will have more information. More...
 
bool HasPermission (GenericPermissions prm)
 Checks to see if the currently logged in user has permission to perform the generic action on this object More...
 
bool HasPropertyPermission (GenericPermissions prm, PropertyIds propId)
 Checks to see if the currently logged in user has permission to perform the generic action on the specified property of this object More...
 
- Public Member Functions inherited from HP.HPTRIM.SDK.TrimPropertySet
TrimIcon GetPropertyIcon (PropertyIds propertyId)
 Gets the icon value associated the a property of this object. More...
 
TrimMainObject GetPropertyTrimObject (PropertyIds dnPropId)
 
string GetPropertyString (PropertyIds dnPropId)
 
int GetPropertyLong (PropertyIds dnPropId)
 
long GetPropertyLong64 (PropertyIds dnPropId)
 
bool GetPropertyBool (PropertyIds dnPropId)
 
TrimDateTime GetPropertyDate (PropertyIds dnPropId)
 
TrimDecimal GetPropertyDecimal (PropertyIds dnPropId)
 
TrimCurrency GetPropertyCurrency (PropertyIds dnPropId)
 
TrimURI GetPropertyUri (PropertyIds dnPropId)
 
bool SetPropertyTrimObject (PropertyIds dnPropId, TrimMainObject newValue)
 
bool SetPropertyString (PropertyIds dnPropId, string newValue)
 
bool SetPropertyLong (PropertyIds dnPropId, int newValue)
 
bool SetPropertyLong64 (PropertyIds dnPropId, long newValue)
 
bool SetPropertyBool (PropertyIds dnPropId, bool newValue)
 
bool SetPropertyDate (PropertyIds dnPropId, TrimDateTime newValue)
 
bool SetPropertyCurrency (PropertyIds dnPropId, TrimCurrency newValue)
 
bool SetPropertyDecimal (PropertyIds dnPropId, TrimDecimal newValue)
 
bool SetPropertyDouble (PropertyIds dnPropId, double newValue)
 
bool SetPropertyUri (PropertyIds dnPropId, TrimURI newValue)
 
bool ClearProperty (PropertyIds dnPropId)
 
object GetProperty (PropertyIds propId)
 
bool SetProperty (PropertyIds propId, object newValue)
 
string GetPropertyAsString (PropertyIds propertyId, StringDisplayType propertyValueStringType, bool useHTMLEscapeChars)
 Gets a string representation of a property value in a format appropriate for a specific use. More...
 
bool IsMandatory (PropertyIds propertyId)
 Gets a boolean value indication whether the specified property must have a non-NULL value for this object. More...
 
bool VerifyProperty (PropertyIds propertyId, bool doMandatoryChecks)
 Verifies the value of a particular property, by cross checking it against other property values. The ErrorMessage property provides details if the verification fails. More...
 
bool CanModifyProperty (PropertyIds propertyId)
 Indicates whether the current user has the permission to modify the specified property. More...
 

Properties

Location AdministeredBy [get]
 Gets a location object representing the administrator for this space - either specifically assigned one or the first adminstrator defined up the hierarchy More...
 
Location Administrator [get, set]
 Gets a location object representing the administrator that has been assigned specifically for this space More...
 
string AdvancedUsageDetails [get]
 Gets a string containing a description of the usage of this space. Includes advanced calculations. More...
 
long Available [get]
 Gets a number indicating the number of records that may still be added to this space (including lower level spaces) before it reaches its total capacity. The total capacity of this space is held in the Space.Capacity property. The total number of records that are already stored in this space and its lower level spaces is held in the Space.Used property. More...
 
long Capacity [get, set]
 Gets or sets a number indicating the total capacity of this space level. That is, the total number of records that can be stored within this space including all spaces within this selected space level. The number of records that are already stored in this space is held in the Space.Used property. The number of records that may still be added to this space is held in the Space.Available property. More...
 
string Description [get]
 Gets a string containing a description of this Space object, which consists of its Level Name and Number. For example, 'Area 1' or 'Slot 4'. More...
 
long DestroyedAllBays [get]
 Gets an integer indicating how many records from all holding bays within this selected space level have been destroyed. That is, the number of records with the holding bay of this space or any of its lower levels as home location that have a disposition of 'Destroyed'. More...
 
long DestroyedInBay [get]
 Gets a number indicating how many records within the holding bay for this space have been destroyed. That is, the number of records with the holding bay of this space as home location that have a disposition of 'Destroyed'. More...
 
long DestroyedRecords [get]
 Gets a number indicating how many records within this space have been destroyed. That is, the number of records with this space as home location that have a disposition of 'Destroyed'. More...
 
string ForeignBarcode [get, set]
 Gets or sets a string containing an external organization's barcode for this Space. This property may be used in conjunction with a barcode scanner in 'Set Home Location' mode to transfer records into this storage location. More...
 
string FullDescription [get]
 Gets a string containing a full description of this space, including the hierarchy it belongs to. For example, 'Warehouse 1, Floor 3, Bay 7.' More...
 
bool HasHoldingBay [get, set]
 Gets or sets a Boolean value indicating whether this space has a holding bay. A holding bay is a temporary storage place where records may be held until they are ready to be transferred. More...
 
bool IsCaptioned [get]
 Gets a Boolean value indicating whether this level has been captioned. That is, if the title of this level has been customized by the user. Use the Content Manager client interface to change the level captions. More...
 
bool IsLowestLevel [get]
 Gets a Boolean value indicating whether this space is the lowest level in the Space System. If it is the lowest level, it will not contain any spaces. Use the Space.CreateLowerLevels method to create new lower levels for this Space. More...
 
SpaceLevel Level [get]
 Gets a slSpaceLevel enum value indicating the level name of this space. The values are: Warehouse, Floor, Area, Bay, Row, Shelf, Slot. More...
 
string NickName [get, set]
 Gets or sets a string containing the unique name for this Space object. This is the Quick Search Key by which this space may be identified in a Content Manager search. It is left empty by default. More...
 
long NodeAvailable [get]
 Gets a number indicating the number of records that may still be added to this space (including lower level spaces) before it reaches its total capacity. The total capacity of this space is held in the Space.Capacity property. The total number of records that are already stored in this space and its lower level spaces is held in the Space.Used property. More...
 
long NodeCapacity [get]
 Gets or sets a number indicating the total capacity of this space level. That is, the total number of records that can be stored within this space including all spaces within this selected space level. The number of records that are already stored in this space is held in the Space.Used property. The number of records that may still be added to this space is held in the Space.Available property. More...
 
long NodeUsed [get]
 Gets a number indicating the number of records that are currently stored in this space including all spaces within this selected space level. The number of records that may still be added to this space is held in the Space.Available property. The total capacity of this space is held in the Space.Capacity property. More...
 
string Number [get]
 Gets a string containing the number of this space. The number differentiates this space from the other spaces of the same level which are contained within the same parent space. By default the first new lower level created will have a value of 0001, unless the numbering is started at a different value at the time of lower level creation. For example, the 1st row of the 3rd area of the 2nd Warehouse created will have a default number of '0002-0003-0001'. More...
 
long RecordsActualAllBays [get]
 Gets a number indicating how many records are actually in any holding bays within this selected space level. That is, the number of records with the holding bay for this space or any of its lower levels as home location which are currently assigned to the holding bay. More...
 
long RecordsActuallyAtHome [get]
 Gets an integer indicating how many records are actually at home. That is, the number of records with this Space as their home location which are currently assigned to this space. More...
 
long RecordsActuallyInBay [get]
 Gets an integer indicating how many records are actually in the holding bay for this space. That is, the number of records with the holding bay for this space as home location which are currently assigned to the holding bay. More...
 
long RecordsAdded2YearsAgo [get]
 Gets a number indicating how many records were added to this space during the calendar year previous to last year (i.e. two years ago). More...
 
long RecordsAddedLastYear [get]
 Gets a number indicating how many records were added to this space within the previous calendar year. More...
 
long RecordsAddedThisYear [get]
 Gets a number indicating how many records have been added to this space since the beginning of this year. More...
 
long RecordsAllBays [get]
 Gets a number indicating how many records are stored in all holding bays within this selected level. That is, the number of records with the holding bay for this space or any of its lower levels as home location. More...
 
long RecordsAtHome [get]
 Gets an integer indicating how many records have this Space object as home location. More...
 
long RecordsInHoldingBay [get]
 Gets an integer indicating how many records have the holding bay for this space as home location. A holding bay is a temporary storage place where records may be held until they are ready to be transferred. This space has a holding bay if the Space.HasHoldingBay property is set to true. More...
 
long RecordsLoanAllBays [get]
 Gets a number indicating how many records are on loan from all holding bays within this selected space level. That is, the number of records with the holding bay for this space or any of its lower levels as home location which are not currently assigned to the holding bay. More...
 
long RecordsOut [get]
 Gets a number indicating how many records are currently out on loan. That is, the number of records with this Space as their home location which are currently not assigned to this space. More...
 
long RecordsOutOfBay [get]
 Gets a number indicating how many records belonging in the holding bay for this space are out on loan. That is, the number of records with the holding bay for this space as home location which are not currently assigned to the holding bay. More...
 
string UsageDetails [get]
 Gets a string containing a description of the usage of this space. This includes information about the total capacity of this space, remaining capacity available, total records allocated, and records allocated to a holding bay. More...
 
long Used [get]
 Gets a number indicating the number of records that are currently stored in this space including all spaces within this selected space level. The number of records that may still be added to this space is held in the Space.Available property. The total capacity of this space is held in the Space.Capacity property. More...
 
Space Within [get]
 Gets the Space object which is the parent level within which this space is contained. If this space is a top-level space, a null value will be returned. More...
 
TrimSecurityProfile SecurityProfile [get, set]
 
TrimAccessControlList AccessControlList [get, set]
 
- Properties inherited from HP.HPTRIM.SDK.TrimMainObject
TrimDateTime LastUpdatedOn [get]
 Returns the date and time that changes to this object were last committed. More...
 
Location LastUpdatedBy [get]
 Returns the user that committed the most recent change to this object. More...
 
string Name [get]
 Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...
 
bool Verified [get]
 Gets a Boolean value indicating whether the object has been verified. That is, whether a call to the 'Verify' method has been made and has succeeded. More...
 
string WebURL [get]
 
bool IsInFavorites [get]
 Gets a boolean value indicating whether this object is in the current user's list of favorites More...
 
string UpdateComment [get, set]
 Gets or sets a string value to be recorded with any audit entries related to the update of this object More...
 
- Properties inherited from HP.HPTRIM.SDK.TrimObject
BaseObjectTypes TrimType [get]
 Gets a BaseObjectTypes enum value indicating the type of this object. More...
 
TrimURI Uri [get]
 Gets the unique row identifier for this object. Once an object has been committed to the database, typically by calling a Save method, this unique identifier is allocated. From that time on, the uri will remain constant and can never be changed. It is always unique across all objects of the same Type. More...
 
string URN [get]
 Gets the uniform resource name for this object. More...
 
string NameString [get]
 Gets a string name for this object which is a user-friendly way of displaying this object. For most TRIM objects the name is a unique string, although some times this is not the case (eg Location Names). More...
 
string NameStringExtra [get]
 Gets a more verbose description of this object, particularly when the name is perhaps a little cryptic or not enough to fully describe the object. More...
 
bool IsReadOnly [get]
 Gets a boolean parameter indicating if this object is "ReadOnly". This would generally indicate that none of the object's properties could be modified, in some cases there are exceptions that can be tested via CanModifyProperty method. More...
 
bool PossiblyHasSubordinates [get]
 Indicates if this object could possibly have child objects of the same type that can be displayed in a hierarchy. More...
 
- Properties inherited from HP.HPTRIM.SDK.TrimPropertySet
string ErrorMessage [get]
 All TRIM SDK objects have an ErrorMessage property which can be used to examine any error that may have occurred in the most recent method call. More...
 
TrimException Error [get]
 All TRIM SDK objects have an Error property which can be used to examine any error that may have occurred in the most recent method call. More...
 
Database Database [get]
 Gets the TRIM Database object in which this object resides. All TRIM objects live within a particular TRIM database and cannot be created without one. More...
 
virtual string Caption [get]
 Gets the user-defined caption that has been associated with all TrimPropertySets of this type. More...
 
virtual TrimIcon Icon [get]
 Gets the icon value associated this TrimPropertySet. More...
 
bool IsModified [get]
 Gets a boolean parameter indicating if any changes have been made to this object since it was first constructed, or last saved. More...
 
- Properties inherited from HP.HPTRIM.SDK.ITrimSecurity
TrimSecurityProfile SecurityProfile [get, set]
 Gets or sets the security profile attached to this object. More...
 
- Properties inherited from HP.HPTRIM.SDK.ITrimAccessControl
TrimAccessControlList AccessControlList [get, set]
 Gets or sets the access control list attached to this object. More...
 

Detailed Description

Represents a location for long term archival storage of physical records, typically within a warehouse

Constructor & Destructor Documentation

HP.HPTRIM.SDK.Space.Space ( Database  database,
TrimURI  uri 
)
HP.HPTRIM.SDK.Space.Space ( Database  database,
string  name 
)
HP.HPTRIM.SDK.Space.Space ( Database  database)

Member Function Documentation

void HP.HPTRIM.SDK.Space.AddToFavorites ( )

Adds the object to the special user label called 'Favorites'

Implements HP.HPTRIM.SDK.ITrimLabels.

void HP.HPTRIM.SDK.Space.ApplyUserLabel ( UserLabel  userLabelToApply)

Creates a link between the nominated user label and this object.

Implements HP.HPTRIM.SDK.ITrimLabels.

bool HP.HPTRIM.SDK.Space.ChangePositionWithinFavorites ( LabelPositionChange  positionChange)

Changes the position of this object within a users list of favorite objects of this type

Implements HP.HPTRIM.SDK.ITrimLabels.

bool HP.HPTRIM.SDK.Space.ChangePositionWithinUserLabel ( UserLabel  userLabelToChange,
LabelPositionChange  positionChange 
)

Changes the position of this object within a users list of objects that have been labeled with the specified user label

Implements HP.HPTRIM.SDK.ITrimLabels.

TrimMainObjectSearch HP.HPTRIM.SDK.Space.CreateLowerLevels ( int  nbrOfSpacesToCreate,
int  capacityOfEachSpace,
int  startNumberingFrom,
int  createAtLevel 
)
void HP.HPTRIM.SDK.Space.DetachUserLabel ( UserLabel  userLabelToDetach)

Removes the link between the nominated user label and this object.

Implements HP.HPTRIM.SDK.ITrimLabels.

UserFieldValue HP.HPTRIM.SDK.Space.GetFieldValue ( FieldDefinition  userFieldType)

Gets the value of the nominated user-defined field for this object.

Implements HP.HPTRIM.SDK.ITrimUserFields.

string HP.HPTRIM.SDK.Space.GetFieldValueAsString ( FieldDefinition  userFieldType,
StringDisplayType  fieldValueStringType,
bool  useHTMLEscapeChars 
)

Gets a string representation of a user-defined field value in a format appropriate for a specific use.

Implements HP.HPTRIM.SDK.ITrimUserFields.

void HP.HPTRIM.SDK.Space.RemoveFromFavorites ( )

Removes the object from the special user label called 'Favorites'

Implements HP.HPTRIM.SDK.ITrimLabels.

void HP.HPTRIM.SDK.Space.SetFieldValue ( FieldDefinition  userFieldType,
UserFieldValue  newFieldValue 
)

Sets the value of the nominated user-defined field for this object.

Implements HP.HPTRIM.SDK.ITrimUserFields.

Property Documentation

TrimAccessControlList HP.HPTRIM.SDK.Space.AccessControlList
getset
Location HP.HPTRIM.SDK.Space.AdministeredBy
get

Gets a location object representing the administrator for this space - either specifically assigned one or the first adminstrator defined up the hierarchy

Location HP.HPTRIM.SDK.Space.Administrator
getset

Gets a location object representing the administrator that has been assigned specifically for this space

string HP.HPTRIM.SDK.Space.AdvancedUsageDetails
get

Gets a string containing a description of the usage of this space. Includes advanced calculations.

long HP.HPTRIM.SDK.Space.Available
get

Gets a number indicating the number of records that may still be added to this space (including lower level spaces) before it reaches its total capacity. The total capacity of this space is held in the Space.Capacity property. The total number of records that are already stored in this space and its lower level spaces is held in the Space.Used property.

long HP.HPTRIM.SDK.Space.Capacity
getset

Gets or sets a number indicating the total capacity of this space level. That is, the total number of records that can be stored within this space including all spaces within this selected space level. The number of records that are already stored in this space is held in the Space.Used property. The number of records that may still be added to this space is held in the Space.Available property.

string HP.HPTRIM.SDK.Space.Description
get

Gets a string containing a description of this Space object, which consists of its Level Name and Number. For example, 'Area 1' or 'Slot 4'.

long HP.HPTRIM.SDK.Space.DestroyedAllBays
get

Gets an integer indicating how many records from all holding bays within this selected space level have been destroyed. That is, the number of records with the holding bay of this space or any of its lower levels as home location that have a disposition of 'Destroyed'.

long HP.HPTRIM.SDK.Space.DestroyedInBay
get

Gets a number indicating how many records within the holding bay for this space have been destroyed. That is, the number of records with the holding bay of this space as home location that have a disposition of 'Destroyed'.

long HP.HPTRIM.SDK.Space.DestroyedRecords
get

Gets a number indicating how many records within this space have been destroyed. That is, the number of records with this space as home location that have a disposition of 'Destroyed'.

string HP.HPTRIM.SDK.Space.ForeignBarcode
getset

Gets or sets a string containing an external organization's barcode for this Space. This property may be used in conjunction with a barcode scanner in 'Set Home Location' mode to transfer records into this storage location.

string HP.HPTRIM.SDK.Space.FullDescription
get

Gets a string containing a full description of this space, including the hierarchy it belongs to. For example, 'Warehouse 1, Floor 3, Bay 7.'

bool HP.HPTRIM.SDK.Space.HasHoldingBay
getset

Gets or sets a Boolean value indicating whether this space has a holding bay. A holding bay is a temporary storage place where records may be held until they are ready to be transferred.

bool HP.HPTRIM.SDK.Space.IsCaptioned
get

Gets a Boolean value indicating whether this level has been captioned. That is, if the title of this level has been customized by the user. Use the Content Manager client interface to change the level captions.

bool HP.HPTRIM.SDK.Space.IsLowestLevel
get

Gets a Boolean value indicating whether this space is the lowest level in the Space System. If it is the lowest level, it will not contain any spaces. Use the Space.CreateLowerLevels method to create new lower levels for this Space.

SpaceLevel HP.HPTRIM.SDK.Space.Level
get

Gets a slSpaceLevel enum value indicating the level name of this space. The values are: Warehouse, Floor, Area, Bay, Row, Shelf, Slot.

string HP.HPTRIM.SDK.Space.NickName
getset

Gets or sets a string containing the unique name for this Space object. This is the Quick Search Key by which this space may be identified in a Content Manager search. It is left empty by default.

long HP.HPTRIM.SDK.Space.NodeAvailable
get

Gets a number indicating the number of records that may still be added to this space (including lower level spaces) before it reaches its total capacity. The total capacity of this space is held in the Space.Capacity property. The total number of records that are already stored in this space and its lower level spaces is held in the Space.Used property.

long HP.HPTRIM.SDK.Space.NodeCapacity
get

Gets or sets a number indicating the total capacity of this space level. That is, the total number of records that can be stored within this space including all spaces within this selected space level. The number of records that are already stored in this space is held in the Space.Used property. The number of records that may still be added to this space is held in the Space.Available property.

long HP.HPTRIM.SDK.Space.NodeUsed
get

Gets a number indicating the number of records that are currently stored in this space including all spaces within this selected space level. The number of records that may still be added to this space is held in the Space.Available property. The total capacity of this space is held in the Space.Capacity property.

string HP.HPTRIM.SDK.Space.Number
get

Gets a string containing the number of this space. The number differentiates this space from the other spaces of the same level which are contained within the same parent space. By default the first new lower level created will have a value of 0001, unless the numbering is started at a different value at the time of lower level creation. For example, the 1st row of the 3rd area of the 2nd Warehouse created will have a default number of '0002-0003-0001'.

long HP.HPTRIM.SDK.Space.RecordsActualAllBays
get

Gets a number indicating how many records are actually in any holding bays within this selected space level. That is, the number of records with the holding bay for this space or any of its lower levels as home location which are currently assigned to the holding bay.

long HP.HPTRIM.SDK.Space.RecordsActuallyAtHome
get

Gets an integer indicating how many records are actually at home. That is, the number of records with this Space as their home location which are currently assigned to this space.

long HP.HPTRIM.SDK.Space.RecordsActuallyInBay
get

Gets an integer indicating how many records are actually in the holding bay for this space. That is, the number of records with the holding bay for this space as home location which are currently assigned to the holding bay.

long HP.HPTRIM.SDK.Space.RecordsAdded2YearsAgo
get

Gets a number indicating how many records were added to this space during the calendar year previous to last year (i.e. two years ago).

long HP.HPTRIM.SDK.Space.RecordsAddedLastYear
get

Gets a number indicating how many records were added to this space within the previous calendar year.

long HP.HPTRIM.SDK.Space.RecordsAddedThisYear
get

Gets a number indicating how many records have been added to this space since the beginning of this year.

long HP.HPTRIM.SDK.Space.RecordsAllBays
get

Gets a number indicating how many records are stored in all holding bays within this selected level. That is, the number of records with the holding bay for this space or any of its lower levels as home location.

long HP.HPTRIM.SDK.Space.RecordsAtHome
get

Gets an integer indicating how many records have this Space object as home location.

long HP.HPTRIM.SDK.Space.RecordsInHoldingBay
get

Gets an integer indicating how many records have the holding bay for this space as home location. A holding bay is a temporary storage place where records may be held until they are ready to be transferred. This space has a holding bay if the Space.HasHoldingBay property is set to true.

long HP.HPTRIM.SDK.Space.RecordsLoanAllBays
get

Gets a number indicating how many records are on loan from all holding bays within this selected space level. That is, the number of records with the holding bay for this space or any of its lower levels as home location which are not currently assigned to the holding bay.

long HP.HPTRIM.SDK.Space.RecordsOut
get

Gets a number indicating how many records are currently out on loan. That is, the number of records with this Space as their home location which are currently not assigned to this space.

long HP.HPTRIM.SDK.Space.RecordsOutOfBay
get

Gets a number indicating how many records belonging in the holding bay for this space are out on loan. That is, the number of records with the holding bay for this space as home location which are not currently assigned to the holding bay.

TrimSecurityProfile HP.HPTRIM.SDK.Space.SecurityProfile
getset
string HP.HPTRIM.SDK.Space.UsageDetails
get

Gets a string containing a description of the usage of this space. This includes information about the total capacity of this space, remaining capacity available, total records allocated, and records allocated to a holding bay.

long HP.HPTRIM.SDK.Space.Used
get

Gets a number indicating the number of records that are currently stored in this space including all spaces within this selected space level. The number of records that may still be added to this space is held in the Space.Available property. The total capacity of this space is held in the Space.Capacity property.

Space HP.HPTRIM.SDK.Space.Within
get

Gets the Space object which is the parent level within which this space is contained. If this space is a top-level space, a null value will be returned.