Copyright (c) Microsoft Corporation. All rights reserved.
Licensed under the MIT License. See License.txt in the project root for
license information.
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 */
package com.microsoft.azure.management.locks;

import com.microsoft.azure.management.apigeneration.Beta;
import com.microsoft.azure.management.apigeneration.Beta.SinceVersion;
import com.microsoft.azure.management.apigeneration.Fluent;
import com.microsoft.azure.management.locks.implementation.AuthorizationManager;
import com.microsoft.azure.management.locks.implementation.ManagementLockObjectInner;
import com.microsoft.azure.management.resources.ResourceGroup;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasId;
import com.microsoft.azure.management.resources.fluentcore.arm.models.HasManager;
import com.microsoft.azure.management.resources.fluentcore.arm.models.Resource;
import com.microsoft.azure.management.resources.fluentcore.model.Creatable;
import com.microsoft.azure.management.resources.fluentcore.model.HasInner;
import com.microsoft.azure.management.resources.fluentcore.model.Indexable;
import com.microsoft.azure.management.resources.fluentcore.model.Refreshable;
import com.microsoft.azure.management.resources.fluentcore.model.Updatable;
import com.microsoft.azure.management.resources.fluentcore.model.Appliable;

Management lock.
/**
 * Management lock.
 */
@Fluent()
@Beta(SinceVersion.V1_4_0)
public interface ManagementLock extends
        Indexable,
        Refreshable<ManagementLock>,
        Updatable<ManagementLock.Update>,
        HasInner<ManagementLockObjectInner>,
        HasManager<AuthorizationManager>,
        HasId {

    // Getters

    
Returns:
the lock level/**
     * @return the lock level
     */
    LockLevel level();

    
Returns:
the resource ID of the locked resource/**
     * @return the resource ID of the locked resource
     */
    String lockedResourceId();

    
Returns:
any notes associated with the lock/**
     * @return any notes associated with the lock
     */
    String notes();

    
Container interface for all the definitions.
/**
     * Container interface for all the definitions.
     */
    interface Definition extends
        DefinitionStages.Blank,
        DefinitionStages.WithLockedResource,
        DefinitionStages.WithLevel,
        DefinitionStages.WithCreate {
    }

    
Grouping of management lock definition stages.
/**
     * Grouping of management lock definition stages.
     */
    interface DefinitionStages {
        
The first stage of a management lock definition.
/**
         * The first stage of a management lock definition.
         */
        interface Blank
            extends WithLockedResource {
        }

        
The stage of a management lock definition allowing to specify notes for the lock.
/**
         * The stage of a management lock definition allowing to specify notes for the lock.
         */
        interface WithLevel {
            
Specifies the lock level.
Params:
level – the level of the lock
Returns:
the next stage of the definition/**
             * Specifies the lock level.
             * @param level the level of the lock
             * @return the next stage of the definition
             */
            WithCreate withLevel(LockLevel level);
        }

        
The stage of a management lock definition allowing to specify the level of the lock.
/**
         * The stage of a management lock definition allowing to specify the level of the lock.
         */
        interface WithNotes {
            
Specifies the notes for the lock.
Params:
notes – the notes
Returns:
the next stage of the definition/**
             * Specifies the notes for the lock.
             *
             * @param notes the notes
             * @return the next stage of the definition
             */
            WithCreate withNotes(String notes);
        }

        
The stage of a management lock definition allowing to specify the resource to lock.
/**
         * The stage of a management lock definition allowing to specify the resource to lock.
         */
        interface WithLockedResource {
            
Specifies the resource to lock.
Params:
resourceId – the resource ID of the resource to lock
Returns:
the next stage of the definition/**
             * Specifies the resource to lock.
             * @param resourceId the resource ID of the resource to lock
             * @return the next stage of the definition
             */
            WithLevel withLockedResource(String resourceId);

            
Specifies the resource to lock.
Params:
resource – the resource to lock
Returns:
the next stage of the definition/**
             * Specifies the resource to lock.
             * @param resource the resource to lock
             * @return the next stage of the definition
             */
            WithLevel withLockedResource(Resource resource);

            
Specifies the resource group to lock.
Params:
resourceGroupName – the name of a resource group
Returns:
the next stage of the definition/**
             * Specifies the resource group to lock.
             * @param resourceGroupName the name of a resource group
             * @return the next stage of the definition
             */
            WithLevel withLockedResourceGroup(String resourceGroupName);

            
Specifies the resource group to lock.
Params:
resourceGroup – a resource group
Returns:
then next stage of the definition/**
             * Specifies the resource group to lock.
             * @param resourceGroup a resource group
             * @return then next stage of the definition
             */
            WithLevel withLockedResourceGroup(ResourceGroup resourceGroup);
        }

        
The stage of the management lock definition which contains all the minimum required inputs for
the resource to be created but also allows
for any other optional settings to be specified.
/**
         * The stage of the management lock definition which contains all the minimum required inputs for
         * the resource to be created but also allows
         * for any other optional settings to be specified.
         */
        interface WithCreate extends
            Creatable<ManagementLock>,
            DefinitionStages.WithNotes {
        }
    }

    
Container interface for all the updates.
/**
     * Container interface for all the updates.
     */
    interface Update extends
        Appliable<ManagementLock>,
        UpdateStages.WithLevel,
        UpdateStages.WithLockedResource {
    }

    
Grouping of management lock update stages.
/**
     * Grouping of management lock update stages.
     */
    interface UpdateStages {

        
The stage of a management lock definition allowing to specify the level of the lock.
/**
         * The stage of a management lock definition allowing to specify the level of the lock.
         */
        interface WithNotes {
            
Specifies the notes for the lock.
Params:
notes – the notes
Returns:
the next stage of the definition/**
             * Specifies the notes for the lock.
             *
             * @param notes the notes
             * @return the next stage of the definition
             */
            Update withNotes(String notes);
        }

        
The stage of a management lock update allowing to specify the resource to lock.
/**
         * The stage of a management lock update allowing to specify the resource to lock.
         */
        interface WithLockedResource {
            
Specifies the resource to lock.
Params:
resourceId – the resource ID of the resource to lock
Returns:
the next stage of the update/**
             * Specifies the resource to lock.
             * @param resourceId the resource ID of the resource to lock
             * @return the next stage of the update
             */
            Update withLockedResource(String resourceId);

            
Specifies the resource to lock.
Params:
resource – the resource to lock
Returns:
the next stage of the update/**
             * Specifies the resource to lock.
             * @param resource the resource to lock
             * @return the next stage of the update
             */
            Update withLockedResource(Resource resource);

            
Specifies the resource group to lock.
Params:
resourceGroupName – the name of a resource group
Returns:
the next stage of the update/**
             * Specifies the resource group to lock.
             * @param resourceGroupName the name of a resource group
             * @return the next stage of the update
             */
            Update withLockedResourceGroup(String resourceGroupName);

            
Specifies the resource group to lock.
Params:
resourceGroup – a resource group
Returns:
then next stage of the update/**
             * Specifies the resource group to lock.
             * @param resourceGroup a resource group
             * @return then next stage of the update
             */
            Update withLockedResourceGroup(ResourceGroup resourceGroup);
        }

        
The stage of a management lock update allowing to modify the level of the lock.
/**
         * The stage of a management lock update allowing to modify the level of the lock.
         */
        interface WithLevel {
            
Specifies the lock level.
Params:
level – the level of the lock
Returns:
the next stage of the definition/**
             * Specifies the lock level.
             * @param level the level of the lock
             * @return the next stage of the definition
             */
            Update withLevel(LockLevel level);
        }
    }
}