레시피 스키마 메서드 및 이벤트

파라미터와 결과를 포함한 레시피 스키마의 메서드 및 이벤트.

메서드

다음 표에서는 메서드 및 관련 매개 변수에 대해 설명합니다.
IDE 및 C# API를 통해 사용할 수 있는 메서드
메서드
입력 인수
출력 인수
CreateRecipe
스토어에 새 레시피를 만듭니다.
  • RecipeId [RecipeId]
  • Result [CreateRecipeResultCode]
    • 성공: 레시피가 성공적으로 만들어졌습니다
    • 레시피ID누락: 메서드가 빈 레시피ID로 호출되었습니다
    • 레시피가이미있음: 이름과 버전이 같은 레시피가 이미 존재합니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다
    • 오류: 오류가 발생했습니다
DuplicateRecipe
기존 레시피를 새 식별자로 복제합니다.
  • RecipeId [RecipeId]
  • NewRecipeId [RecipeId]
  • Result [DuplicateRecipeResultCode]
    • 성공: 레시피가 성공적으로 복제되었습니다
    • 일반오류: 레시피 복제하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다(예: 데이터베이스 오류)
    • 예기치않은빈소스레시피이름: 제공된 소스 레시피 이름이 비어 있거나 null입니다
    • 예기치않은빈대상레시피이름: 제공된 대상 레시피 이름이 비어 있거나 null입니다
    • 소스레시피가없음: 저장소에서 소스 레시피를 찾을 수 없습니다
    • 대상레시피가이미있음: 해당 대상 이름을 가진 레시피가 이미 있습니다
    • 대상을찾을수없음: 레시피 복제를 위한 대상 노드를 찾을 수 없습니다
RenameRecipe
기존 레시피의 이름을 변경합니다.
  • RecipeId [RecipeId]
  • NewName [String]
  • Result [RenameRecipeResultCode]
    • 성공: 레시피 이름을 성공적으로 바꿨습니다
    • 일반오류: 레시피 이름을 바꾸는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다(예: 데이터베이스 오류)
    • 예기치않은빈레시피이름: 제공된 레시피 이름이 비어 있거나 null입니다
    • 소스레시피가없음: 저장소에서 소스 레시피를 찾을 수 없습니다
    • 대상레시피가이미있음: 해당 대상 이름을 가진 레시피가 이미 있습니다
DeleteRecipe
스토어에서 기존 레시피를 삭제합니다.
  • RecipeId [RecipeId]
  • Result [DeleteRecipeResultCode]
    • 성공: 레시피가 성공적으로 삭제되었습니다
    • 일반오류: 레시피를 삭제하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다(예: 데이터베이스 오류)
    • 예기치않은빈레시피이름: 제공된 레시피 이름이 비어 있거나 null입니다
    • 레시피가없음: 지정된 레시피를 저장소에서 찾을 수 없습니다
리팩터링
리팩터링 작업을 비동기적으로 수행합니다.
  • 없음
없음. 유일한 비동기 메서드입니다. 작업이 완료되면 이벤트(리팩터링완료됨)가 전송됩니다.
GetDataItems
레시피와 연결된 데이터 항목을 검색합니다.
  • RecipeId [RecipeId]
  • Result [GetDataItemsResultCode]
    • 성공: 데이터 항목이 성공적으로 검색되었습니다
    • 레시피를찾을수없음: 지정된 레시피를 저장소에서 찾을 수 없습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다(예: 데이터베이스 오류)
    • 일반오류: 데이터 항목을 검색하는 동안 일반 오류가 발생했습니다
SetRecipeDataItemValue
레시피에서 특정 데이터 항목의 값을 설정합니다.
  • RecipeId [RecipeId]
  • ItemRelativeBrowsePath [String]
  • DataItemRelativeBrowsePath [String]
  • ElementAccess [ElementAccess]
  • Value [BaseDataType]
  • Result [SetRecipeDataItemValueResultCode]
    • 성공: 레시피 데이터 항목 값이 성공적으로 설정되었습니다
    • 일반오류: 데이터 항목 값을 설정하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다(예: 데이터베이스 오류)
    • 데이터항목을찾을수없음: 레시피에서 지정된 데이터 항목을 찾을 수 없습니다
    • 예기치않은빈레시피이름: 제공된 레시피 이름이 비어 있거나 null입니다
    • 레시피를찾을수없음: 지정된 레시피를 저장소에서 찾을 수 없습니다
SetRecipeMetadataValue
레시피의 특정 메타데이터 필드 값을 설정합니다.
  • RecipeId [RecipeId]
  • MetadataName [String]
  • Value [BaseDataType]
  • Result [SetRecipeMetadataValueResultCode]
    • 성공: 레시피 메타데이터 값이 성공적으로 설정되었습니다
    • 일반오류: 메타데이터 값을 설정하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다(예: 데이터베이스 오류)
    • 예기치않은빈레시피이름: 제공된 레시피 이름이 비어 있거나 null입니다
    • 레시피를찾을수없음: 지정된 레시피를 저장소에서 찾을 수 없습니다
    • 메타데이터를찾을수없음: 레시피에서 지정된 메타데이터 필드를 찾을 수 없습니다
TransferFromEditModelToStore
편집 모델에서 스토어로 레시피를 전송합니다.
  • RequesterNodeId [NodeId]
  • RecipeId [RecipeId]
  • Result [TransferFromEditModelToStoreResultCode]
    • 성공레시피만들어짐: 레시피가 성공적으로 생성되고 편집 모델에서 저장소로 전송되었습니다
    • 성공레시피업데이트됨: 레시피가 성공적으로 업데이트되고 편집 모델에서 저장소로 전송되었습니다
    • 일반오류: 편집 모델에서 저장소로 전송하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다(예: 데이터베이스 오류)
    • 요청자노드를찾을수없음: 요청자 노드를 찾을 수 없습니다
    • 예기치않은빈레시피이름: 제공된 레시피 이름이 비어 있거나 null입니다
    • 대상을찾을수없음: 전송 대상 노드를 찾을 수 없습니다
    • 편집모델노드를찾을수없음: 편집 모델 노드를 찾을 수 없습니다
TransferFromEditModelToTarget
편집 모델에서 대상 노드로 레시피를 전송합니다.
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicyDataType]
  • Result [TransferFromEditModelToTargetResultCode]
    • 성공: 레시피가 편집 모델에서 대상으로 성공적으로 전송되었습니다
    • 일반오류: 편집 모델에서 대상으로 전송하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다(예: 데이터베이스 오류)
    • 요청자노드를찾을수없음: 요청자 노드를 찾을 수 없습니다
    • 대상을찾을수없음: 전송 대상 노드를 찾을 수 없습니다
    • 편집모델노드를찾을수없음: 편집 모델 노드를 찾을 수 없습니다
    • 데이터불일치: 편집 모델 데이터와 대상 구조 간에 불일치가 있습니다
TransferFromStoreToEditModel
스토어에서 편집 모델로 레시피를 전송합니다.
  • RequesterNodeId [NodeId]
  • RecipeId [RecipeId]
  • Result [TransferFromEditModelToTargetResultCode]
    • 성공: 레시피가 편집 모델에서 대상으로 성공적으로 전송되었습니다
    • 일반오류: 편집 모델에서 대상으로 전송하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다(예: 데이터베이스 오류)
    • 요청자노드를찾을수없음: 요청자 노드를 찾을 수 없습니다
    • 대상을찾을수없음: 전송 대상 노드를 찾을 수 없습니다
    • 편집모델노드를찾을수없음: 편집 모델 노드를 찾을 수 없습니다
    • 데이터불일치: 편집 모델 데이터와 대상 구조 간에 불일치가 있습니다
TransferFromStoreToTarget
스토어에서 대상 노드로 레시피를 전송합니다.
  • RecipeId [RecipeId]
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicyDataType]
  • Result [TransferFromStoreToTargetResultCode]
    • 성공: 레시피가 저장소에서 대상으로 성공적으로 전송되었습니다
    • 일반오류: 저장소에서 대상으로 전송하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다(예: 데이터베이스 오류)
    • 예기치않은빈레시피이름: 제공된 레시피 이름이 비어 있거나 null입니다
    • 레시피를찾을수없음: 지정된 레시피를 저장소에서 찾을 수 없습니다
    • 대상을찾을수없음: 전송 대상 노드를 찾을 수 없습니다
    • 데이터불일치: 레시피 데이터와 대상 구조 간에 불일치가 있습니다
TransferFromTargetToEditModel
대상 노드에서 편집 모델로 레시피를 전송합니다.
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicyDataType]
  • Result [TransferFromTargetToEditModelResultCode]
    • 성공: 레시피가 대상에서 편집 모델로 성공적으로 전송되었습니다
    • 일반오류: 대상에서 편집 모델로 전송하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다(예: 데이터베이스 오류)
    • 요청자노드를찾을수없음: 요청자 노드를 찾을 수 없습니다
    • 대상을찾을수없음: 전송 대상 노드를 찾을 수 없습니다
    • 편집모델노드를찾을수없음: 편집 모델 노드를 찾을 수 없습니다
    • 데이터불일치: 대상 데이터와 편집 모델 구조 간에 불일치가 있습니다
TransferFromTargetToStore
대상 노드에서 스토어로 레시피를 전송합니다.
  • RecipeId [RecipeId]
  • TargetNodeId [NodeId]
  • Overwrite [Bool]
  • ErrorPolicy [ErrorPolicyDataType]
  • Result [TransferFromTargetToStoreResultCode]
    • 성공레시피만들어짐: 레시피가 성공적으로 생성되고 대상에서 저장소로 전송되었습니다
    • 성공레시피업데이트됨: 레시피가 성공적으로 업데이트되고 대상에서 저장소로 전송되었습니다
    • 일반오류: 대상에서 저장소로 전송하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다(예: 데이터베이스 오류)
    • 예기치않은빈레시피이름: 제공된 레시피 이름이 비어 있거나 null입니다
    • 레시피가이미있음: 이름이 같은 레시피가 저장소에 존재합니다
    • 대상을찾을수없음: 전송 대상 노드를 찾을 수 없습니다
    • 데이터불일치: 대상 데이터와 저장소 구조 간에 불일치가 있습니다
C# API를 통해서만 사용할 수 있는 메서드
메서드
입력 인수
출력 인수
GetRecipes
스토어의 모든 레시피 목록을 검색합니다.
입력 인수 없음
  • Result [GetRecipesResult] (Array)
    • 성공: 레시피가 성공적으로 검색되었습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다
    • 일반오류: 레시피를 검색하는 동안 일반 오류가 발생했습니다
GetRecipeMetadataValue
레시피의 특정 메타데이터 필드 값을 검색합니다.
  • RecipeId [RecipeId]
  • MetadataName [String]
  • Result [GetRecipeMetadataValueResult]
    • 성공: 레시피 메타데이터 값이 성공적으로 검색되었습니다
    • 일반오류: 메타데이터 값을 검색하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다
    • 예기치않은빈레시피이름: 제공된 레시피 이름이 비어 있거나 null입니다
    • 레시피를찾을수없음: 지정된 레시피를 저장소에서 찾을 수 없습니다
    • 메타데이터를찾을수없음: 레시피에서 지정된 메타데이터 필드를 찾을 수 없습니다
GetRecipeMetadataValues
레시피와 연결된 모든 메타데이터 값을 검색합니다.
RecipeId [RecipeId]
  • Result [GetRecipeMetadataValuesResult]
    • 성공: 레시피 메타데이터 값이 성공적으로 검색되었습니다
    • 일반오류: 메타데이터 값을 검색하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다
    • 예기치않은빈레시피이름: 제공된 레시피 이름이 비어 있거나 null입니다
    • 레시피를찾을수없음: 지정된 레시피를 저장소에서 찾을 수 없습니다
GetRecipeDataItemValue
레시피에서 특정 데이터 항목의 값을 검색합니다.
  • RecipeId [RecipeId]
  • ItemRelativeBrowsePath [String] (Array)
  • DataItemRelativeBrowsePath [String] (Array)
  • ElementAccess [ElementAccess]
  • Result [GetRecipeDataItemValueResult]
    • 성공: 레시피 데이터 항목 값이 성공적으로 검색되었습니다
    • 일반오류: 데이터 항목 값을 검색하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다
    • 데이터항목을찾을수없음: 레시피에서 지정된 데이터 항목을 찾을 수 없습니다
    • 예기치않은빈레시피이름: 제공된 레시피 이름이 비어 있거나 null입니다
    • 레시피를찾을수없음: 지정된 레시피를 저장소에서 찾을 수 없습니다
CreateEditModel
레시피에 대한 편집 모델을 생성합니다.
  • ParentNodeId [NodeId]
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • RecipeId [RecipeId]
  • Result [CreateEditModelResultCode]
    • 성공: 편집 모델이 성공적으로 만들어졌습니다
    • 일반오류: 편집 모델을 생성하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다
    • 상위노드를찾을수없음: 편집 모델의 상위 노드를 찾을 수 없습니다
    • 요청자노드를찾을수없음: 요청자 노드를 찾을 수 없습니다
TransferFromStores
스토어에서 대상 노드로 레시피를 전송합니다.
RecipeId [RecipeId]
  • Result [TransferFromStoreResultCode]
    • 성공: 레시피가 스토어에서 성공적으로 전송되었습니다
    • 일반오류: 저장소에서 전송하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다
    • 레시피를찾을수없음: 지정된 레시피를 저장소에서 찾을 수 없습니다
    • 대상을찾을수없음: 전송 대상 노드를 찾을 수 없습니다
TransferToStore
레시피를 스토어로 전송합니다.
  • RecipeId [RecipeId]
  • Result [TransferToStoreResultCode]
    • 성공: 레시피가 스토어로 성공적으로 전송되었습니다
    • 일반오류: 저장소로 전송하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다
대상으로전송
레시피를 대상 노드로 전송합니다.
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicy]
  • Result [TransferToTargetResultCode]
    • 성공: 레시피가 대상으로 성공적으로 전송되었습니다
    • 일반오류: 대상으로 전송하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다
    • 대상을찾을수없음: 전송 대상 노드를 찾을 수 없습니다
    • 데이터불일치: 레시피 데이터와 대상 구조 간에 불일치가 있습니다
TransferFromTarget
대상 노드에서 스토어로 레시피를 전송합니다.
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicy]
  • Result [TransferFromTargetResultCode]
    • 성공: 레시피가 대상에서 성공적으로 전송되었습니다
    • 일반오류: 대상에서 전송하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다
    • 대상을찾을수없음: 전송 대상 노드를 찾을 수 없습니다
    • 데이터불일치: 대상 데이터와 레시피 구조 간에 불일치가 있습니다
SetDataItemValue
특정 데이터 항목의 값을 설정합니다.
  • ItemId [NodeId]
  • DataItemRelativeBrowsePath [String] (Array)
  • ElementAccess [ElementAccess]
  • DataTypeId [NodeId]
  • Value [BaseDataType]
  • Result [SetDataItemValueResultCode]
    • 성공: 데이터 항목 값이 성공적으로 설정되었습니다
    • 일반오류: 데이터 항목 값을 설정하는 동안 일반 오류가 발생했습니다
    • 저장소오류: 저장소에 액세스하는 동안 오류가 발생했습니다
    • 데이터항목을찾을수없음: 지정된 데이터 항목을 찾을 수 없습니다

이벤트

레시피 스키마에는 다음 이벤트가 포함됩니다.
리팩터링 완료됨
메서드 리팩터링이 완료되면 발생합니다.
레시피 응용 프로그램 이벤트
TransferFromStoreToTarget 또는 TransferEditModelToTarget가 완료되면 발생합니다.
의견을 작성 부탁드립니다.
이 자료에 대한 문의사항이나 요청사항이 있습니까? 여기에 요청사항을 작성 부탁드립니다.
Normal