# Package com.io7m.cardant.protocol.inventory.cb

@Export @Version("1.0.0") package com.io7m.cardant.protocol.inventory.cb
Inventory system (Inventory protocol [Cedarbridge encoding])

- Related Packages
  Package
  Description
  com.io7m.cardant.protocol.inventory
  Inventory system (Inventory protocol)
  com.io7m.cardant.protocol.inventory.cb.internal
  Inventory system (Inventory protocol [Cedarbridge encoding [internals]])
- Class
  Description
  CAI1Attachment
  An item attachment.
  CAI1AttachmentKey
  The values that uniquely identify an attachment on an object.
  CAI1AuditEvent
  An audit event.
  CAI1AuditSearchParameters
  The audit search parameters.
  CAI1CommandAuditSearchBegin
  Start searching audit events.
  CAI1CommandAuditSearchNext
  Continue searching audit events.
  CAI1CommandAuditSearchPrevious
  Continue searching audit events.
  CAI1CommandFileDelete
  Delete files.
  CAI1CommandFileGet
  Retrieve a file.
  CAI1CommandFilePut
  Add or update files.
  CAI1CommandFileSearchBegin
  Start searching for items.
  CAI1CommandFileSearchNext
  Return the next page of search results.
  CAI1CommandFileSearchPrevious
  Return the next page of search results.
  CAI1CommandItemAttachmentAdd
  Add item attachments.
  CAI1CommandItemAttachmentRemove
  Remove item attachments.
  CAI1CommandItemCreate
  Create a new item.
  CAI1CommandItemDelete
  Delete items.
  CAI1CommandItemGet
  Retrieve an item.
  CAI1CommandItemLocationsList
  List all the locations an item is in, and how many times the item is in them.
  CAI1CommandItemMetadataPut
  Add or update metadata values in an item.
  CAI1CommandItemMetadataRemove
  Remove metadata values from an item.
  CAI1CommandItemSearchBegin
  Start searching for items.
  CAI1CommandItemSearchNext
  Return the next page of search results.
  CAI1CommandItemSearchPrevious
  Return the next page of search results.
  CAI1CommandItemSetName
  Update the names of items.
  CAI1CommandItemTypesAssign
  Assign a set of types to an item.
  CAI1CommandItemTypesRevoke
  Revoke a set of types from an item.
  CAI1CommandLocationAttachmentAdd
  Add location attachments.
  CAI1CommandLocationAttachmentRemove
  Remove location attachments.
  CAI1CommandLocationDelete
  Delete locations.
  CAI1CommandLocationGet
  Retrieve a location.
  CAI1CommandLocationList
  List locations.
  CAI1CommandLocationMetadataPut
  Add or update metadata values in a location.
  CAI1CommandLocationMetadataRemove
  Remove metadata values from a location.
  CAI1CommandLocationPut
  Create or update a location.
  CAI1CommandLocationTypesAssign
  Assign a set of types to a location.
  CAI1CommandLocationTypesRevoke
  Revoke a set of types from a location.
  CAI1CommandLogin
  A request to log in.
  CAI1CommandRolesAssign
  Assign a set of roles to a user.
  CAI1CommandRolesGet
  Get the roles for a user.
  CAI1CommandRolesRevoke
  Revoke a set of roles from a user.
  CAI1CommandStockCount
  Count stock.
  CAI1CommandStockReposit
  Reposit an item.
  CAI1CommandStockSearchBegin
  Search stock.
  CAI1CommandStockSearchNext
  Search stock.
  CAI1CommandStockSearchPrevious
  Search stock.
  CAI1CommandTypePackageGetText
  Get a type package.
  CAI1CommandTypePackageInstall
  Install a type package.
  CAI1CommandTypePackageSearchBegin
  Start searching type packages.
  CAI1CommandTypePackageSearchNext
  Continue searching type packages.
  CAI1CommandTypePackageSearchPrevious
  Continue searching type packages.
  CAI1CommandTypePackageUninstall
  Uninstall a type package.
  CAI1CommandTypePackageUpgrade
  Upgrade a type package.
  CAI1ComparisonExact<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonExact.Anything<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonExact.IsEqualTo<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonExact.IsNotEqualTo<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonFuzzy<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonFuzzy.Anything<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonFuzzy.IsEqualTo<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonFuzzy.IsNotEqualTo<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonFuzzy.IsNotSimilarTo<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonFuzzy.IsSimilarTo<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonSet<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonSet.Anything<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonSet.IsEqualTo<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonSet.IsNotEqualTo<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonSet.IsOverlapping<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonSet.IsSubsetOf<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1ComparisonSet.IsSupersetOf<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  CAI1Error
  An error response.
  CAI1EventUpdated
  Data on the server was updated.
  CAI1File
  A file.
  CAI1File.CAI1FileWithData
  CAI1File.CAI1FileWithoutData
  CAI1FileColumn
  The item column by which to order results.
  CAI1FileColumn.CAI1ByDescription
  Order by file description.
  CAI1FileColumn.CAI1ById
  Order by file ID.
  CAI1FileColumnOrdering
  The file column by which to order results.
  CAI1FileSearchParameters
  The file search parameters.
  CAI1Id
  An identifier value.
  CAI1Id.CAI1FileID
  CAI1Id.CAI1ItemID
  CAI1Id.CAI1LocationID
  CAI1Id.CAI1StockInstanceID
  CAI1Id.CAI1UserID
  CAI1IncludeDeleted
  Include deleted data in search results.
  CAI1IncludeDeleted.IncludeLiveAndDeleted
  Include both live and deleted data.
  CAI1IncludeDeleted.IncludeOnlyDeleted
  Include only deleted data.
  CAI1IncludeDeleted.IncludeOnlyLive
  Include only live data.
  CAI1Item
  An item.
  CAI1ItemColumn
  The item column by which to order results.
  CAI1ItemColumn.CAI1ById
  Order by item ID.
  CAI1ItemColumn.CAI1ByName
  Order by item name.
  CAI1ItemColumnOrdering
  The item column by which to order results.
  CAI1ItemSearchParameters
  The item search parameters.
  CAI1ItemSerial
  A serial number.
  CAI1ItemSummary
  A summary of an item.
  CAI1Location
  A location.
  CAI1LocationMatch
  The behaviour requested for matching locations.
  CAI1LocationMatch.CAI1LocationAny
  Consider all locations.
  CAI1LocationMatch.CAI1LocationExact
  Only consider the exact given location.
  CAI1LocationMatch.CAI1LocationWithDescendants
  Consider the given location and all descendants of the given location.
  CAI1LocationSummary
  A summary of a location.
  CAI1Messages
  The protocol messages for Inventory Cedarbridge.
  CAI1Metadata
  A metadata value.
  CAI1Metadata.Integral
  CAI1Metadata.Monetary
  CAI1Metadata.Real
  CAI1Metadata.Text
  CAI1Metadata.Time
  CAI1MetadataElementMatch
  An expression against which item metadata is matched.
  CAI1MetadataElementMatch.And
  CAI1MetadataElementMatch.Or
  CAI1MetadataElementMatch.Specific
  CAI1MetadataValueMatch
  An expression against which item metadata values are matched.
  CAI1MetadataValueMatch.Anything
  CAI1MetadataValueMatch.IntegralWithinRange
  CAI1MetadataValueMatch.MonetaryWithCurrency
  CAI1MetadataValueMatch.MonetaryWithinRange
  CAI1MetadataValueMatch.RealWithinRange
  CAI1MetadataValueMatch.TextExact
  CAI1MetadataValueMatch.TextSearch
  CAI1MetadataValueMatch.TimeWithinRange
  CAI1Page<T extends com.io7m.cedarbridge.runtime.api.CBSerializableType>
  A page of search results.
  CAI1ResponseAuditSearch
  A response to CAI1CommandAuditSearchBegin.
  CAI1ResponseBlame
  A blame assignment.
  CAI1ResponseBlame.BlameClient
  The client sent a bad response.
  CAI1ResponseBlame.BlameServer
  Something went wrong on the server.
  CAI1ResponseError
  An error response.
  CAI1ResponseFileDelete
  A response to CAI1CommandFileDelete.
  CAI1ResponseFileGet
  A response to CAI1CommandFileGet.
  CAI1ResponseFilePut
  A response to CAI1CommandFilePut.
  CAI1ResponseFileSearch
  A response to CAI1CommandFileSearch.
  CAI1ResponseItemAttachmentAdd
  A response to CAI1CommandItemAttachmentAdd.
  CAI1ResponseItemAttachmentRemove
  A response to CAI1CommandItemAttachmentRemove.
  CAI1ResponseItemCreate
  A response to CAI1CommandItemCreate.
  CAI1ResponseItemDelete
  A response to CAI1CommandItemDelete.
  CAI1ResponseItemGet
  A response to CAI1CommandItemGet.
  CAI1ResponseItemMetadataPut
  A response to CAI1CommandItemMetadataPut.
  CAI1ResponseItemMetadataRemove
  A response to CAI1CommandItemMetadataRemove.
  CAI1ResponseItemSearch
  A response to CAI1CommandItemSearch.
  CAI1ResponseItemSetName
  A response to CAI1CommandItemSetName.
  CAI1ResponseItemTypesAssign
  A response to CAI1CommandItemTypesAssign.
  CAI1ResponseItemTypesRevoke
  A response to CAI1CommandItemTypesRevoke.
  CAI1ResponseLocationAttachmentAdd
  A response to CAI1CommandLocationAttachmentAdd.
  CAI1ResponseLocationAttachmentRemove
  A response to CAI1CommandLocationAttachmentRemove.
  CAI1ResponseLocationDelete
  A response to CAI1CommandLocationDelete.
  CAI1ResponseLocationGet
  A response to CAI1CommandLocationGet.
  CAI1ResponseLocationList
  A response to CAI1CommandLocationList.
  CAI1ResponseLocationMetadataPut
  A response to CAI1CommandLocationMetadataPut.
  CAI1ResponseLocationMetadataRemove
  A response to CAI1CommandLocationMetadataRemove.
  CAI1ResponseLocationPut
  A response to CAI1CommandLocationPut.
  CAI1ResponseLocationTypesAssign
  A response to CAI1CommandLocationTypesAssign.
  CAI1ResponseLocationTypesRevoke
  A response to CAI1CommandLocationTypesRevoke.
  CAI1ResponseLogin
  A response to CAI1CommandLogin.
  CAI1ResponseRolesAssign
  A response to CAI1ResponseRolesAssign.
  CAI1ResponseRolesGet
  A response to CAI1ResponseRolesGet.
  CAI1ResponseRolesRevoke
  A response to CAI1ResponseRolesRevoke.
  CAI1ResponseStockCount
  A response to CAI1CommandStockCount.
  CAI1ResponseStockReposit
  A response to CAI1CommandStockReposit.
  CAI1ResponseStockSearch
  A response to CAI1CommandStockSearch.
  CAI1ResponseTypePackageGetText
  A response to CAI1CommandTypePackageGetText.
  CAI1ResponseTypePackageInstall
  A response to CAI1CommandTypePackageInstall.
  CAI1ResponseTypePackageSearch
  A response to CAI1CommandTypePackageSearch.
  CAI1ResponseTypePackageUninstall
  A response to CAI1CommandTypePackageUninstall.
  CAI1ResponseTypePackageUpgrade
  A response to CAI1CommandTypePackageUpgrade.
  CAI1SizeRange
  A size range.
  CAI1StockOccurrence
  CAI1StockOccurrence.Serial
  CAI1StockOccurrence.Set
  CAI1StockOccurrenceKind
  CAI1StockOccurrenceKind.Serial
  CAI1StockOccurrenceKind.Set
  CAI1StockReposit
  The type of item reposit operations.
  CAI1StockReposit.CAI1StockRepositSerialIntroduce
  An operation that adds a single identified item to a storage location.
  CAI1StockReposit.CAI1StockRepositSerialMove
  An operation that moves a single identified item between storage locations.
  CAI1StockReposit.CAI1StockRepositSerialNumberAdd
  An operation that adds a serial number to an instance.
  CAI1StockReposit.CAI1StockRepositSerialNumberRemove
  An operation that removes a serial number from an instance.
  CAI1StockReposit.CAI1StockRepositSerialRemove
  An operation that removes a single identified item.
  CAI1StockReposit.CAI1StockRepositSetAdd
  An operation that adds a set of items to an instance.
  CAI1StockReposit.CAI1StockRepositSetIntroduce
  An operation that adds a set of items to a storage location.
  CAI1StockReposit.CAI1StockRepositSetMove
  An operation that moves a set of items from one storage location to another.
  CAI1StockReposit.CAI1StockRepositSetRemove
  An operation that removes a set of items from a storage location.
  CAI1StockSearchParameters
  The stock search parameters.
  CAI1TimeRange
  An inclusive time range.
  CAI1TypeField
  A field within a type declaration.
  CAI1TypePackageIdentifier
  The type package identifier.
  CAI1TypePackageSearchParameters
  The type package search parameters.
  CAI1TypePackageSummary
  The type package summary.
  CAI1TypePackageTypeRemovalBehavior
  The type package type removal behavior.
  CAI1TypePackageTypeRemovalBehavior.FailIfTypesReferenced
  CAI1TypePackageTypeRemovalBehavior.RevokeTypes
  CAI1TypePackageUninstall
  The type package uninstall parameters.
  CAI1TypePackageVersionBehavior
  The type package version behavior.
  CAI1TypePackageVersionBehavior.AllowDowngrades
  CAI1TypePackageVersionBehavior.DisallowDowngrades
  CAI1TypeRecord
  A type declaration.
  CAI1TypeRecordFieldIdentifier
  CAI1TypeRecordIdentifier
  CAI1TypeRecordSearchParameters
  The declared type search parameters.
  CAI1TypeRecordSummary
  A type declaration summary.
  CAI1TypeScalar
  A scalar type.
  CAI1TypeScalar.Integral
  CAI1TypeScalar.Monetary
  CAI1TypeScalar.Real
  CAI1TypeScalar.Text
  CAI1TypeScalar.Time
  CAI1TypeScalarIdentifier
  CAI1TypeScalarSearchParameters
  The scalar type search parameters.
  CAI1Validation
  Functions to translate between the core command set and the Inventory v1 Cedarbridge encoding command set.
  CAI1Version
  A version number.
  ProtocolCAI
  Protocol `com.io7m.cardant.protocol.inventory.cb.CAI`.
  ProtocolCAIType
  Protocol `com.io7m.cardant.protocol.inventory.cb.CAI`
  ProtocolCAIv1Serializer
  Protocol `com.io7m.cardant.protocol.inventory.cb.CAI`, version `1`.
  ProtocolCAIv1Type
  Protocol `com.io7m.cardant.protocol.inventory.cb.CAI`, version `1`.