SecureObject (openCRX/Core API)

All Known Subinterfaces:

Absence, Absence, AbstractActivityParty, AbstractActivityParty, AbstractBudget, AbstractBudget, AbstractContract, AbstractContract, AbstractEMailRecipient, AbstractEMailRecipient, AbstractEntry, AbstractEntry, AbstractGroup, AbstractGroup, AbstractInvoicePosition, AbstractInvoicePosition, AbstractMailingRecipient, AbstractMailingRecipient, AbstractOpportunityPosition, AbstractOpportunityPosition, AbstractPhoneCallRecipient, AbstractPhoneCallRecipient, AbstractPriceLevel, AbstractPriceLevel, AbstractProduct, AbstractProduct, AbstractQuotePosition, AbstractQuotePosition, AbstractRemovedPosition, AbstractRemovedPosition, AbstractSalesOrderPosition, AbstractSalesOrderPosition, AbstractTask, AbstractTask, AccessHistory, AccessHistory, Account, Account, AccountAddress, AccountAddress, AccountAddress, AccountAddress, AccountAssignment, AccountAssignment, AccountAssignmentActivityGroup, AccountAssignmentActivityGroup, AccountAssignmentContract, AccountAssignmentContract, AccountAssignmentInventoryItem, AccountAssignmentInventoryItem, AccountAssignmentProduct, AccountAssignmentProduct, AccountAttributeFilterProperty, AccountAttributeFilterProperty, AccountCategoryFilterProperty, AccountCategoryFilterProperty, AccountFilterGlobal, AccountFilterGlobal, AccountFilterProperty, AccountFilterProperty, AccountMembership, AccountMembership, AccountMembershipFilterProperty, AccountMembershipFilterProperty, AccountQueryFilterProperty, AccountQueryFilterProperty, AccountTypeFilterProperty, AccountTypeFilterProperty, Activity, Activity, ActivityAttributeFilterProperty, ActivityAttributeFilterProperty, ActivityCategory, ActivityCategory, ActivityCreationAction, ActivityCreationAction, ActivityCreator, ActivityCreator, ActivityFilterCalendarFeed, ActivityFilterCalendarFeed, ActivityFilterGlobal, ActivityFilterGlobal, ActivityFilterGroup, ActivityFilterGroup, ActivityFilterProperty, ActivityFilterProperty, ActivityFollowUp, ActivityFollowUp, ActivityGroup, ActivityGroup, ActivityGroupAssignment, ActivityGroupAssignment, ActivityGroupCalendarFeed, ActivityGroupCalendarFeed, ActivityGroupRelationship, ActivityGroupRelationship, ActivityLinkFrom, ActivityLinkFrom, ActivityLinkTo, ActivityLinkTo, ActivityMilestone, ActivityMilestone, ActivityNumberFilterProperty, ActivityNumberFilterProperty, ActivityProcess, ActivityProcess, ActivityProcessAction, ActivityProcessAction, ActivityProcessState, ActivityProcessState, ActivityProcessStateFilterProperty, ActivityProcessStateFilterProperty, ActivityProcessTransition, ActivityProcessTransition, ActivityQueryFilterProperty, ActivityQueryFilterProperty, ActivityRelationship, ActivityRelationship, ActivityStateFilterProperty, ActivityStateFilterProperty, ActivityTracker, ActivityTracker, ActivityType, ActivityType, ActivityTypeFilterProperty, ActivityTypeFilterProperty, ActivityVote, ActivityVote, ActivityWorkRecord, ActivityWorkRecord, AdditionalExternalLink, AdditionalExternalLink, AddressAccountMembershipFilterProperty, AddressAccountMembershipFilterProperty, AddressAttributeFilterProperty, AddressAttributeFilterProperty, AddressCategoryFilterProperty, AddressCategoryFilterProperty, AddressDisabledFilterProperty, AddressDisabledFilterProperty, AddressFilterGlobal, AddressFilterGlobal, AddressFilterProperty, AddressFilterProperty, AddressGroup, AddressGroup, AddressGroupMember, AddressGroupMember, AddressMainFilterProperty, AddressMainFilterProperty, AddressQueryFilterProperty, AddressQueryFilterProperty, AddressTypeFilterProperty, AddressTypeFilterProperty, AddressUsageFilterProperty, AddressUsageFilterProperty, AirSyncClientProfile, AirSyncClientProfile, AirSyncProfile, AirSyncProfile, Alert, Alert, AliasType, AliasType, Artifact, Artifact, ArtifactContext, ArtifactContext, ArtifactDependency, ArtifactDependency, Asset, Asset, AssetContext, AssetContext, AssignedToFilterProperty, AssignedToFilterProperty, AssignmentBasedFolderEntry, AssignmentBasedFolderEntry, Association, Association, AssociationEnd, AssociationEnd, Attribute, Attribute, AuditEntry, AuditEntry, BehaviouralFeature, BehaviouralFeature, Booking, Booking, BookingPeriod, BookingPeriod, BookingText, BookingText, BooleanProperty, BooleanProperty, BooleanPropertySetEntry, BooleanPropertySetEntry, Budget, Budget, Building, Building, BuildingComplex, BuildingComplex, BuildingUnit, BuildingUnit, CalculationRule, CalculationRule, Calendar, Calendar, CalendarDay, CalendarDay, CalendarProfile, CalendarProfile, CardProfile, CardProfile, CategoryFilterProperty, CategoryFilterProperty, CategoryFilterProperty, CategoryFilterProperty, Class, Class, ClassificationElement, ClassificationElement, Classifier, Classifier, CodeValueContainer, CodeValueContainer, CodeValueEntry, CodeValueEntry, CollectionType, CollectionType, Competitor, Competitor, ComponentConfiguration, ComponentConfiguration, CompoundBooking, CompoundBooking, ConfigurationModification, ConfigurationModification, Constant, Constant, Constraint, Constraint, Contact, Contact, ContactMembership, ContactMembership, ContactRelationship, ContactRelationship, ContactRole, ContactRole, ContactsFeed, ContactsFeed, ContractAddress, ContractAddress, ContractAttributeFilterProperty, ContractAttributeFilterProperty, ContractCreator, ContractCreator, ContractFilterGlobal, ContractFilterGlobal, ContractFilterGroup, ContractFilterGroup, ContractFilterProperty, ContractFilterProperty, ContractGroup, ContractGroup, ContractGroupAssignment, ContractGroupAssignment, ContractLinkFrom, ContractLinkFrom, ContractLinkTo, ContractLinkTo, ContractPriorityFilterProperty, ContractPriorityFilterProperty, ContractQueryFilterProperty, ContractQueryFilterProperty, ContractRole, ContractRole, ContractStateFilterProperty, ContractStateFilterProperty, ContractType, ContractType, ContractTypeFilterProperty, ContractTypeFilterProperty, CreditBooking, CreditBooking, CreditLimit, CreditLimit, CrxObject, CrxObject, CustomerContractRole, CustomerContractRole, CustomerFilterProperty, CustomerFilterProperty, Datatype, Datatype, DateProperty, DateProperty, DatePropertySetEntry, DatePropertySetEntry, DateTimeProperty, DateTimeProperty, DateTimePropertySetEntry, DateTimePropertySetEntry, DebitBooking, DebitBooking, DecimalProperty, DecimalProperty, DecimalPropertySetEntry, DecimalPropertySetEntry, DefaultSalesTaxTypeFilterProperty, DefaultSalesTaxTypeFilterProperty, DeliveryInformation, DeliveryInformation, DeliveryRequest, DeliveryRequest, Depot, Depot, DepotAddress, DepotAddress, DepotContract, DepotContract, DepotEntity, DepotEntity, DepotEntityRelationship, DepotEntityRelationship, DepotGroup, DepotGroup, DepotHolder, DepotHolder, DepotPosition, DepotPosition, DepotReference, DepotReference, DepotReport, DepotReport, DepotReportItem, DepotReportItem, DepotReportItemPosition, DepotReportItemPosition, DepotType, DepotType, Description, Description, Descriptor, Descriptor, DescriptorGroup, DescriptorGroup, DesignDiagram, DesignDiagram, DesignModel, DesignModel, DesignPart, DesignPart, DisabledFilterProperty, DisabledFilterProperty, DisabledFilterProperty, DisabledFilterProperty, DisabledFilterProperty, DisabledFilterProperty, DisabledFilterProperty, DisabledFilterProperty, DisabledFilterProperty, DisabledFilterProperty, DiscountPriceModifier, DiscountPriceModifier, Document, Document, DocumentAttachment, DocumentAttachment, DocumentAttachment, DocumentAttachment, DocumentAttributeFilterProperty, DocumentAttributeFilterProperty, DocumentBasedFolderEntry, DocumentBasedFolderEntry, DocumentFeed, DocumentFeed, DocumentFilterFeed, DocumentFilterFeed, DocumentFilterGlobal, DocumentFilterGlobal, DocumentFilterProperty, DocumentFilterProperty, DocumentFolder, DocumentFolder, DocumentFolderAssignment, DocumentFolderAssignment, DocumentFolderEntry, DocumentFolderEntry, DocumentFolderFilterProperty, DocumentFolderFilterProperty, DocumentFolderShare, DocumentFolderShare, DocumentLanguageFilterProperty, DocumentLanguageFilterProperty, DocumentLink, DocumentLink, DocumentLock, DocumentLock, DocumentNameFilterProperty, DocumentNameFilterProperty, DocumentProfile, DocumentProfile, DocumentQueryFilterProperty, DocumentQueryFilterProperty, DocumentReference, DocumentReference, DocumentRevision, DocumentRevision, DocumentStateFilterProperty, DocumentStateFilterProperty, DocumentTypeFilterProperty, DocumentTypeFilterProperty, EffortEstimate, EffortEstimate, Element, Element, EMail, EMail, EMailAccount, EMailAccount, EMailAddress, EMailAddress, EMailAddress, EMailAddress, EMailAddress, EMailAddress, EMailAddress, EMailAddress, EMailRecipient, EMailRecipient, EMailRecipientGroup, EMailRecipientGroup, EmploymentContract, EmploymentContract, EnumerationType, EnumerationType, Event, Event, Exception, Exception, ExportProfile, ExportProfile, ExternalActivity, ExternalActivity, ExternalTask, ExternalTask, Facility, Facility, Feature, Feature, FolderAssignment, FolderAssignment, GeneralizableElement, GeneralizableElement, GenericContract, GenericContract, Group, Group, ImplementationPart, ImplementationPart, Import, Import, Incident, Incident, IncidentParty, IncidentParty, IndexEntry, IndexEntry, IntegerProperty, IntegerProperty, IntegerPropertySetEntry, IntegerPropertySetEntry, InterfaceSpec, InterfaceSpec, InventoryItem, InventoryItem, Invoice, Invoice, InvoicePosition, InvoicePosition, InvolvedObject, InvolvedObject, JabberAccount, JabberAccount, Lead, Lead, LegalEntity, LegalEntity, LinearPriceModifier, LinearPriceModifier, LinkableItemLinkFrom, LinkableItemLinkFrom, LinkableItemLinkTo, LinkableItemLinkTo, LinkedActivityFollowUpAction, LinkedActivityFollowUpAction, LocalizedField, LocalizedField, Mailing, Mailing, MailingRecipient, MailingRecipient, MailingRecipientGroup, MailingRecipientGroup, Media, Media, Media, Media, MediaContent, MediaContent, MediaReference, MediaReference, Meeting, Meeting, MeetingParty, MeetingParty, Member, Member, Namespace, Namespace, Note, Note, ObjectCreationAuditEntry, ObjectCreationAuditEntry, ObjectFinder, ObjectFinder, ObjectModificationAuditEntry, ObjectModificationAuditEntry, ObjectRemovalAuditEntry, ObjectRemovalAuditEntry, Operation, Operation, Opportunity, Opportunity, OpportunityPosition, OpportunityPosition, Organization, Organization, OrganizationalUnit, OrganizationalUnit, OrganizationalUnitRelationship, OrganizationalUnitRelationship, Package, Package, Parameter, Parameter, Part, Part, PhoneCall, PhoneCall, PhoneCallRecipient, PhoneCallRecipient, PhoneCallRecipientGroup, PhoneCallRecipientGroup, PhoneNumber, PhoneNumber, PhoneNumber, PhoneNumber, PhoneNumber, PhoneNumber, PhoneNumber, PhoneNumber, PositionCreation, PositionCreation, PositionModification, PositionModification, PositionRemoval, PositionRemoval, PostalAddress, PostalAddress, PostalAddress, PostalAddress, PostalAddress, PostalAddress, PostalAddress, PostalAddress, PriceLevel, PriceLevel, PriceListEntry, PriceListEntry, PriceModifier, PriceModifier, PriceUomFilterProperty, PriceUomFilterProperty, PricingRule, PricingRule, PrimitiveType, PrimitiveType, Product, Product, ProductAddress, ProductAddress, ProductApplication, ProductApplication, ProductAttributeFilterProperty, ProductAttributeFilterProperty, ProductBasePrice, ProductBasePrice, ProductClassification, ProductClassification, ProductClassificationFilterProperty, ProductClassificationFilterProperty, ProductClassificationRelationship, ProductClassificationRelationship, ProductConfiguration, ProductConfiguration, ProductConfigurationType, ProductConfigurationType, ProductConfigurationTypeSet, ProductConfigurationTypeSet, ProductDepotPosition, ProductDepotPosition, ProductFilterGlobal, ProductFilterGlobal, ProductFilterProperty, ProductFilterProperty, ProductPhase, ProductPhase, ProductPhasePriceLevel, ProductPhasePriceLevel, ProductQueryFilterProperty, ProductQueryFilterProperty, ProductReference, ProductReference, Profile, Profile, Property, Property, PropertySet, PropertySet, PropertySet, PropertySet, PropertySetEntry, PropertySetEntry, QuantityBasedSalesVolumeBudgetPosition, QuantityBasedSalesVolumeBudgetPosition, QuantityModification, QuantityModification, QuickAccess, QuickAccess, Quote, Quote, QuotePosition, QuotePosition, Rating, Rating, Reference, Reference, ReferenceProperty, ReferenceProperty, ReferencePropertySetEntry, ReferencePropertySetEntry, RelatedProduct, RelatedProduct, RemovedPosition, RemovedPosition, ReportedByAccountFilterProperty, ReportedByAccountFilterProperty, ReportedByContactFilterProperty, ReportedByContactFilterProperty, RequirementDiagram, RequirementDiagram, RequirementModel, RequirementModel, RequirementPart, RequirementPart, Resource, Resource, ResourceAssignment, ResourceAssignment, ResourceIdentifier, ResourceIdentifier, ResourceRate, ResourceRate, RevenueReport, RevenueReport, Room, Room, Room, Room, Room, Room, SalesContract, SalesContract, SalesContractCreator, SalesContractCreator, SalesOrder, SalesOrder, SalesOrderPosition, SalesOrderPosition, SalesRepFilterProperty, SalesRepFilterProperty, SalesTaxType, SalesTaxType, SalesVisit, SalesVisit, SalesVolumeBudget, SalesVolumeBudget, SalesVolumeBudgetPosition, SalesVolumeBudgetPosition, SalesVolumeContract, SalesVolumeContract, SalesVolumeTarget, SalesVolumeTarget, ScheduledEndFilterProperty, ScheduledEndFilterProperty, ScheduledStartFilterProperty, ScheduledStartFilterProperty, SearchIndexEntry, SearchIndexEntry, SecureObject, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, Segment, ServiceAccount, ServiceAccount, SetActualEndAction, SetActualEndAction, SetActualStartAction, SetActualStartAction, SetAssignedToAction, SetAssignedToAction, SimpleBooking, SimpleBooking, SimpleEntry, SimpleEntry, SingleBooking, SingleBooking, Site, Site, Slot, Slot, SolutionPart, SolutionPart, StringProperty, StringProperty, StringPropertySetEntry, StringPropertySetEntry, StructuralFeature, StructuralFeature, StructureField, StructureField, StructureType, StructureType, SubActivity, SubActivity, SubActivityTransition, SubActivityTransition, Subscription, Subscription, SupplierFilterProperty, SupplierFilterProperty, SyncData, SyncData, SyncFeed, SyncFeed, SyncProfile, SyncProfile, Tag, Tag, Task, Task, TaskParty, TaskParty, TestDiagram, TestDiagram, TestModel, TestModel, TestPart, TestPart, Timer, Timer, Topic, Topic, TotalAmountFilterProperty, TotalAmountFilterProperty, TwitterAccount, TwitterAccount, TypedElement, TypedElement, UnspecifiedAccount, UnspecifiedAccount, Uom, Uom, UomSchedule, UomSchedule, UriProperty, UriProperty, UriPropertySetEntry, UriPropertySetEntry, UseCase, UseCase, UserHome, UserHome, ValueBasedSalesVolumeBudgetPosition, ValueBasedSalesVolumeBudgetPosition, VariabilityPoint, VariabilityPoint, Warehouse, Warehouse, WebAddress, WebAddress, WebAddress, WebAddress, WebAddress, WebAddress, WebAddress, WebAddress, WeekDay, WeekDay, WfAction, WfAction, WfActionLogEntry, WfActionLogEntry, WfProcess, WfProcess, WfProcessInstance, WfProcessInstance, WorkAndExpenseRecord, WorkAndExpenseRecord
```
public interface SecureObject
```
Abstract class SecureObject

Method Summary

Methods
Modifier and Type	Method and Description
`ModifySecureObjectResult`	`addOwningGroup(ModifyOwningGroupParams in)`
`CheckPermissionsResult`	`checkPermissions(CheckPermissionsParams in)`
`short`	`getAccessLevelBrowse()` Retrieves the value for the attribute `accessLevelBrowse`.
`short`	`getAccessLevelDelete()` Retrieves the value for the attribute `accessLevelDelete`.
`short`	`getAccessLevelUpdate()` Retrieves the value for the attribute `accessLevelUpdate`.
`List<String>`	`getOwner()` Retrieves a list containing all the elements for the attribute `owner`.
`<T extends PrincipalGroup> List<T>`	`getOwningGroup()` Retrieves the `Collection` of objects referenced by `owningGroup`.
`User`	`getOwningUser()` Retrieves the value for the reference `owningUser`.
`ModifySecureObjectResult`	`removeAllOwningGroup(RemoveAllOwningGroupParams in)`
`ModifySecureObjectResult`	`removeOwningGroup(ModifyOwningGroupParams in)`
`ModifySecureObjectResult`	`replaceOwningGroup(ModifyOwningGroupsParams in)`
`ModifySecureObjectResult`	`setAccessLevel(SetAccessLevelParams in)`
`void`	`setAccessLevelBrowse(short accessLevelBrowse)` Sets a new value for the attribute `accessLevelBrowse`.
`void`	`setAccessLevelDelete(short accessLevelDelete)` Sets a new value for the attribute `accessLevelDelete`.
`void`	`setAccessLevelUpdate(short accessLevelUpdate)` Sets a new value for the attribute `accessLevelUpdate`.
`void`	`setOwner(String... owner)` Clears `owner` and adds the given value(s).
`ModifySecureObjectResult`	`setOwningUser(SetOwningUserParams in)`
`void`	`setOwningUser(User owningUser)` Sets a new value for the reference `owningUser`.

- Method Detail
  - getAccessLevelBrowse
```
short getAccessLevelBrowse()
```
    Retrieves the value for the attribute accessLevelBrowse.
    
    Returns:
    The non-null value for attribute accessLevelBrowse.
  - setAccessLevelBrowse
```
void setAccessLevelBrowse(short accessLevelBrowse)
```
    Sets a new value for the attribute accessLevelBrowse.
    
    Parameters:
    accessLevelBrowse - The non-null new value for attribute accessLevelBrowse.
  - getAccessLevelDelete
```
short getAccessLevelDelete()
```
    Retrieves the value for the attribute accessLevelDelete.
    
    Returns:
    The non-null value for attribute accessLevelDelete.
  - setAccessLevelDelete
```
void setAccessLevelDelete(short accessLevelDelete)
```
    Sets a new value for the attribute accessLevelDelete.
    
    Parameters:
    accessLevelDelete - The non-null new value for attribute accessLevelDelete.
  - getAccessLevelUpdate
```
short getAccessLevelUpdate()
```
    Retrieves the value for the attribute accessLevelUpdate.
    
    Returns:
    The non-null value for attribute accessLevelUpdate.
  - setAccessLevelUpdate
```
void setAccessLevelUpdate(short accessLevelUpdate)
```
    Sets a new value for the attribute accessLevelUpdate.
    
    Parameters:
    accessLevelUpdate - The non-null new value for attribute accessLevelUpdate.
  - addOwningGroup
```
ModifySecureObjectResult addOwningGroup(ModifyOwningGroupParams in)
```
  - checkPermissions
```
CheckPermissionsResult checkPermissions(CheckPermissionsParams in)
```
  - getOwner
```
List<String> getOwner()
```
    Retrieves a list containing all the elements for the attribute owner.
    
    Returns:
    A list containing all elements for this attribute.
  - setOwner
```
void setOwner(String... owner)
```
    Clears owner and adds the given value(s).
    This method is equivalent to
```
   list.clear();
   for(java.lang.String e : attributeName){
     list.add(e);
   }
 
```
    Parameters:
    owner - value(s) to be added to owner
  - getOwningGroup
```
<T extends PrincipalGroup> List<T> getOwningGroup()
```
    Retrieves the Collection of objects referenced by owningGroup.
    
    Returns:
    The Collection of referenced objects.
  - getOwningUser
```
User getOwningUser()
```
    Retrieves the value for the reference owningUser.
    
    Returns:
    The – possibly null – value for this reference.
  - setOwningUser
```
void setOwningUser(User owningUser)
```
    Sets a new value for the reference owningUser.
    
    Parameters:
    owningUser - The new – possibly null – value for this reference.
  - removeAllOwningGroup
```
ModifySecureObjectResult removeAllOwningGroup(RemoveAllOwningGroupParams in)
```
  - removeOwningGroup
```
ModifySecureObjectResult removeOwningGroup(ModifyOwningGroupParams in)
```
  - replaceOwningGroup
```
ModifySecureObjectResult replaceOwningGroup(ModifyOwningGroupsParams in)
```
  - setAccessLevel
```
ModifySecureObjectResult setAccessLevel(SetAccessLevelParams in)
```
  - setOwningUser
```
ModifySecureObjectResult setOwningUser(SetOwningUserParams in)
```

Interface SecureObject

Method Summary

Method Detail

getAccessLevelBrowse

setAccessLevelBrowse

getAccessLevelDelete

setAccessLevelDelete

getAccessLevelUpdate

setAccessLevelUpdate

addOwningGroup

checkPermissions

getOwner

setOwner

getOwningGroup

getOwningUser

setOwningUser

removeAllOwningGroup

removeOwningGroup

replaceOwningGroup

setAccessLevel

setOwningUser