Reformat catalog-model
[sdc.git] / catalog-model / src / main / java / org / openecomp / sdc / be / model / operations / api / IConsumerOperation.java
index 55c38d0..e9c50bf 100644 (file)
@@ -7,9 +7,9 @@
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
  * You may obtain a copy of the License at
- * 
+ *
  *      http://www.apache.org/licenses/LICENSE-2.0
- * 
+ *
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * limitations under the License.
  * ============LICENSE_END=========================================================
  */
-
 package org.openecomp.sdc.be.model.operations.api;
 
 import fj.data.Either;
-import org.openecomp.sdc.be.resources.data.ConsumerData;
-
 import java.util.List;
+import org.openecomp.sdc.be.resources.data.ConsumerData;
 
 public interface IConsumerOperation {
 
     /**
      * the method updates the node in the graph with the given ConsumerData
      *
-     * @param consumerData
-     *            the object we want to store
-     * @param inTransaction
-     *            inTransaction is the operation part of a transaction, in case the value is false the action will be committed in the end of the method
+     * @param consumerData  the object we want to store
+     * @param inTransaction inTransaction is the operation part of a transaction, in case the value is false the action will be committed in the end
+     *                      of the method
      * @return the updated object returned from the graph
      */
     Either<ConsumerData, StorageOperationStatus> updateCredentials(ConsumerData consumerData, boolean inTransaction);
@@ -41,8 +38,7 @@ public interface IConsumerOperation {
     /**
      * the method updates the node in the graph with the given ConsumerData
      *
-     * @param consumerData
-     *            the object we want to store
+     * @param consumerData the object we want to store
      * @return the updated object returned from the graph
      */
     Either<ConsumerData, StorageOperationStatus> updateCredentials(ConsumerData consumerData);
@@ -50,10 +46,9 @@ public interface IConsumerOperation {
     /**
      * the method deletes the node with the given unique id
      *
-     * @param consumerName
-     *            the unique id by witch we will look up the credential we want to delete
-     * @param inTransaction
-     *            inTransaction is the operation part of a transaction, in case the value is false the action will be committed in the end of the method
+     * @param consumerName  the unique id by witch we will look up the credential we want to delete
+     * @param inTransaction inTransaction is the operation part of a transaction, in case the value is false the action will be committed in the end
+     *                      of the method
      * @return the deleted object returned from the graph
      */
     Either<ConsumerData, StorageOperationStatus> deleteCredentials(String consumerName, boolean inTransaction);
@@ -61,8 +56,7 @@ public interface IConsumerOperation {
     /**
      * the method deletes the node with the given unique id
      *
-     * @param consumerName
-     *            the unique id by witch we will look up the credential we want to delete
+     * @param consumerName the unique id by witch we will look up the credential we want to delete
      * @return the deleted object returned from the graph
      */
     Either<ConsumerData, StorageOperationStatus> deleteCredentials(String consumerName);
@@ -70,10 +64,8 @@ public interface IConsumerOperation {
     /**
      * the method creates a new nod in the grape representing the supplied credential object
      *
-     * @param consumerData
-     *            the object we want to store
-     * @param inTransaction
-     *            is the operation part of a transaction, in case the value is false the action will be committed in the end of the method
+     * @param consumerData  the object we want to store
+     * @param inTransaction is the operation part of a transaction, in case the value is false the action will be committed in the end of the method
      * @return the newly stored object returned from the graph
      */
     Either<ConsumerData, StorageOperationStatus> createCredentials(ConsumerData consumerData, boolean inTransaction);
@@ -81,8 +73,7 @@ public interface IConsumerOperation {
     /**
      * the method creates a new nod in the grape representing the supplied credential object
      *
-     * @param consumerData
-     *            the object we want to store
+     * @param consumerData the object we want to store
      * @return the newly stored object returned from the graph
      */
     Either<ConsumerData, StorageOperationStatus> createCredentials(ConsumerData consumerData);
@@ -90,16 +81,13 @@ public interface IConsumerOperation {
     /**
      * the method retrieves the credential for the given consumer name
      *
-     * @param consumerName
-     *            the unique id by witch we will look up the credential
+     * @param consumerName the unique id by witch we will look up the credential
      * @return ConsumerData or the error received during the operation
      */
     Either<ConsumerData, StorageOperationStatus> getCredentials(String consumerName);
 
     /**
-     *
      * @return all consumers
      */
     Either<List<ConsumerData>, StorageOperationStatus> getAll();
-
 }