Skip to content
common-domain-model

Class: SecurityLocate

A locate is an approval from a broker that needs to be obtained prior to effecting a short sale in an equity security. Similar to security availability, a borrower can request a single or multiple securities, but at least one must be requested.

URI: common_domain_model:SecurityLocate

 classDiagram
    class SecurityLocate
    click SecurityLocate href "../SecurityLocate/"
      AvailableInventory <|-- SecurityLocate
        click AvailableInventory href "../AvailableInventory/"
      
      SecurityLocate : availableInventoryRecord
        
          
    
        
        
        SecurityLocate --> "*" AvailableInventoryRecord : availableInventoryRecord
        click AvailableInventoryRecord href "../AvailableInventoryRecord/"
    

        
      SecurityLocate : availableInventoryType
        
          
    
        
        
        SecurityLocate --> "1" AvailableInventoryTypeEnum : availableInventoryType
        click AvailableInventoryTypeEnum href "../AvailableInventoryTypeEnum/"
    

        
      SecurityLocate : comment
        
      SecurityLocate : identifier
        
          
    
        
        
        SecurityLocate --> "0..1" AssignedIdentifier : identifier
        click AssignedIdentifier href "../AssignedIdentifier/"
    

        
      SecurityLocate : messageInformation
        
          
    
        
        
        SecurityLocate --> "0..1" MessageInformation : messageInformation
        click MessageInformation href "../MessageInformation/"
    

        
      SecurityLocate : party
        
          
    
        
        
        SecurityLocate --> "*" Party : party
        click Party href "../Party/"
    

        
      SecurityLocate : partyRole
        
          
    
        
        
        SecurityLocate --> "*" PartyRole : partyRole
        click PartyRole href "../PartyRole/"

Inheritance

Section titled “Inheritance”

Slots

Section titled “Slots”
Name Cardinality and Range Description Inheritance
availableInventoryType 1
AvailableInventoryTypeEnum		 Defines the purpose of this inventory AvailableInventory
identifier 0..1
AssignedIdentifier		 Unique identifier for this group AvailableInventory
comment 0..1
string		 Optional comments for this group of inventory records AvailableInventory
messageInformation 0..1
MessageInformation		 Allows details related to the availability messaging use case to be defined AvailableInventory
party *
Party		 Defines all parties involved for the list of inventory records in this set of… AvailableInventory
partyRole *
PartyRole		 Defines the role(s) that party(ies) may have in relation to the inventory AvailableInventory
availableInventoryRecord *
AvailableInventoryRecord		 An array holding the list of inventory being described AvailableInventory
Expressions & Logic

All Of

Section titled “All Of”

The class must satisfy all of:

  • AnonymousClassExpression({ ‘description’: (’RequestOneSecurityMinimum: A locate must request the availability of at ’ ‘least one security.’), ‘slot_conditions’: {‘availableInventoryRecord’: SlotDefinition({‘name’: ‘availableInventoryRecord’, ‘value_presence’: PresenceEnum(text=‘PRESENT’)})} })

Identifier and Mapping Information

Section titled “Identifier and Mapping Information”

Annotations

Section titled “Annotations”
property value
rosetta_root_type true

Schema Source

Section titled “Schema Source”

Mappings

Section titled “Mappings”
Mapping Type Mapped Value
self common_domain_model:SecurityLocate
native common_domain_model:SecurityLocate

LinkML Source

Section titled “LinkML Source”

Direct

Section titled “Direct”
name: SecurityLocate
annotations:
  rosetta_root_type:
    tag: rosetta_root_type
    value: 'true'
description: A locate is an approval from a broker that needs to be obtained prior
  to effecting a short sale in an equity security. Similar to security availability,
  a borrower can request a single or multiple securities, but at least one must be
  requested.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: AvailableInventory
all_of:
- description: 'RequestOneSecurityMinimum: A locate must request the availability
    of at least one security.'
  slot_conditions:
    availableInventoryRecord:
      name: availableInventoryRecord
      value_presence: PRESENT

Induced

Section titled “Induced”
name: SecurityLocate
annotations:
  rosetta_root_type:
    tag: rosetta_root_type
    value: 'true'
description: A locate is an approval from a broker that needs to be obtained prior
  to effecting a short sale in an equity security. Similar to security availability,
  a borrower can request a single or multiple securities, but at least one must be
  requested.
from_schema: https://w3id.org/lmodel/common-domain-model
is_a: AvailableInventory
attributes:
  availableInventoryType:
    name: availableInventoryType
    description: Defines the purpose of this inventory.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    owner: SecurityLocate
    domain_of:
    - AvailableInventory
    range: AvailableInventoryTypeEnum
    required: true
  identifier:
    name: identifier
    description: Unique identifier for this group. This can be used to uniquely identify
      a group of inventory records.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: SecurityLocate
    domain_of:
    - AssetBase
    - AssetIdentifier
    - ProductIdentifier
    - AssignedIdentifier
    - BusinessUnit
    - EntityIdentifier
    - PartyIdentifier
    - PersonIdentifier
    - TransferBase
    - ContractualDefinition
    - FloatingRateIndexMap
    - CompositionStep
    - InstructionComposition
    - LegalAgreementBase
    - NonLegalEntity
    - OtherAgreement
    - AvailableInventory
    - InventoryRecord
    - ClauseLibraryClause
    - ClauseLibraryClauseVariant
    - Clause
    - EligibleCollateralSpecification
    - NonTransferableProduct
    range: AssignedIdentifier
  comment:
    name: comment
    description: Optional comments for this group of inventory records.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    owner: SecurityLocate
    domain_of:
    - AvailableInventory
    - AvailableInventoryRecord
    - WorkflowState
    range: string
  messageInformation:
    name: messageInformation
    description: Allows details related to the availability messaging use case to
      be defined
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    owner: SecurityLocate
    domain_of:
    - AvailableInventory
    - WorkflowStep
    range: MessageInformation
  party:
    name: party
    description: Defines all parties involved for the list of inventory records in
      this set of inventory. For example, when used to describe securities lending
      availability, this could hold the sender of the availability, the intended recipient,
      the beneficial owner(s), the lender (which may differ from the sender as the
      lender may have the same piece of availability going through multiple agents),
      an agent or a venue.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: SecurityLocate
    domain_of:
    - AssetBase
    - DebtRedemption
    - MarginCallBase
    - Trade
    - UmbrellaAgreementParty
    - UmbrellaAgreementSet
    - AggregationParameters
    - AvailableInventory
    - CounterpartyPosition
    - WorkflowStep
    - WorkflowStepApproval
    - AdditionalObligations
    - AdditionalRepresentationElection
    - CalculationAgentTerms
    - CalculationCurrencyElection
    - CollateralManagementAgreementElection
    - ControlAgreementElections
    - ControlAgreementNecEventElection
    - CreditSupportDocumentElection
    - CreditSupportProviderElection
    - CustodianElection
    - CustodianRiskElection
    - ElectiveAmountElection
    - FrenchLawAddendumElection
    - HoldingAndUsingPostedCollateralElection
    - LegacyExposureScopeElection
    - LegacyIndependentAmountParty
    - MinimumTransferAmountElection
    - NotificationTimeElection
    - PledgeeRepresentativeRider
    - PostingObligationsElection
    - RecalculationOfValueElection
    - RegimeTerms
    - SecuredPartyRightsEventElection
    - SecurityInterestForObligations
    - SecurityProviderRightsEventElection
    - SensitivityMethodologiesPartyElection
    - SinglePostingParty
    - SpecifiedOrAccessConditionPartyElection
    - SubstitutedRegimeElection
    - SubstitutionPartyElection
    - TerminationCurrencyElection
    - ThresholdElection
    - ValuationAgent
    - ValuationCalculationDateLocationElection
    - AdditionalTerminationEventElection
    - AutomaticEarlyTerminationElection
    - CreditEventUponMergerElection
    - PartyTerminationCurrencySelection
    - SpecifiedEntity
    - EventsOfDefaultElection
    - EligibleCollateralSpecification
    range: Party
    multivalued: true
  partyRole:
    name: partyRole
    description: Defines the role(s) that party(ies) may have in relation to the inventory.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    owner: SecurityLocate
    domain_of:
    - AssetBase
    - MarginCallBase
    - PartyChangeInstruction
    - Trade
    - UmbrellaAgreementParty
    - AvailableInventory
    - AvailableInventoryRecord
    - CounterpartyPosition
    - EligibleCollateralSpecification
    range: PartyRole
    multivalued: true
  availableInventoryRecord:
    name: availableInventoryRecord
    description: An array holding the list of inventory being described. Each element
      in the inventoryRecord array represents an individual piece of inventory i.e.
      a security.
    from_schema: https://w3id.org/lmodel/common-domain-model/cdm_event_position
    rank: 1000
    owner: SecurityLocate
    domain_of:
    - AvailableInventory
    range: AvailableInventoryRecord
    multivalued: true
all_of:
- description: 'RequestOneSecurityMinimum: A locate must request the availability
    of at least one security.'
  slot_conditions:
    availableInventoryRecord:
      name: availableInventoryRecord
      value_presence: PRESENT